From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Po Lu via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#68684: [PATCH] dictonary.el documentation Date: Wed, 24 Jan 2024 20:04:58 +0800 Message-ID: <878r4frl79.fsf@yahoo.com> References: <8734uof4m4.fsf@gmail.com> Reply-To: Po Lu Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35376"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: torsten.hilbrich@gmx.net, 68684@debbugs.gnu.org, iarchivedmywholelife@gmail.com To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jan 24 13:06:20 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rSc1L-0008rQ-Tk for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 24 Jan 2024 13:06:20 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rSc13-0008Pw-4J; Wed, 24 Jan 2024 07:06:01 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rSc0z-0008Ob-KS for bug-gnu-emacs@gnu.org; Wed, 24 Jan 2024 07:05:57 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rSc0z-0007G1-Ay for bug-gnu-emacs@gnu.org; Wed, 24 Jan 2024 07:05:57 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rSc14-0007z8-Ej for bug-gnu-emacs@gnu.org; Wed, 24 Jan 2024 07:06:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Po Lu Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 24 Jan 2024 12:06:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68684 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 68684-submit@debbugs.gnu.org id=B68684.170609792330595 (code B ref 68684); Wed, 24 Jan 2024 12:06:02 +0000 Original-Received: (at 68684) by debbugs.gnu.org; 24 Jan 2024 12:05:23 +0000 Original-Received: from localhost ([127.0.0.1]:44639 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rSc0R-0007xO-2j for submit@debbugs.gnu.org; Wed, 24 Jan 2024 07:05:23 -0500 Original-Received: from sonic303-21.consmr.mail.ne1.yahoo.com ([66.163.188.147]:38929) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rSc0O-0007x5-5G for 68684@debbugs.gnu.org; Wed, 24 Jan 2024 07:05:21 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s2048; t=1706097907; bh=t1pt0LpxhDOJ+kkK4vIIv9OvaDWylp6fo+eEXLXhejM=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From:Subject:Reply-To; b=Q5AF5nFQHNuP5LrMxioAtAy0U9Y0o2E1nr+vKTj+SOyFC3XzqZVTdyXGpA5gtdrLOgRRg8eUJF8mtSZK8AYEEXVS32x2QW2FcYUdTk/MLNamTAlpFbLgQ0hpb2ZWnVNaoFNRwmhBi33YDphJhLFwoiokSF1HZBUPBf0UHSzWqayaBq2I33I5CP0hs6y+0mrh6HcovlaHVHP/y70Z0Uw46Zb3Xz/U/s7VsDbLGfZ2MecSttm01kWCR83szgBlmjkailXardoCvqbYTt9BcH/vN7wgWwHLBK1MSZ1fa2XJqMIEmzvwk2b8KnK347J6l4ldUef4G4xPDBjOqxWelMrHDQ== X-SONIC-DKIM-SIGN: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s2048; t=1706097907; bh=NajtwWrhFtEuJ8SO4me3DFFXKWCbSM/L3q/g0/PdElg=; h=X-Sonic-MF:From:To:Subject:Date:From:Subject; b=j+1tnemIp1jUpR8DhZ16Sq8kBG+pbGb1d/0j4r12YL0pEXi5wl9jnavPQucsXb+uSvFqIVG0iDsq/7+SU4uJDNBZMdp3Q4BN3BFpDLrB5D7bpF2VOuAD4ibXVdlaM1wISAeGoCmv+5cSPCeJ3LsTtgcddW6pHczRn7V4vN2vf3WuHZ+m1eOLR5HUPd1IEd5xO52Ce+dnkOEsf2yWUohG9jABdssgPhg+NyliqbThlyayJ0FkIWuoI44az3imUhqj+0yYQ9whxlkb+27xo0PGKJW4b6ey7gl9YD6pTbHaUMZCxP0TJzhs0u9Nzmvc0qr8WDolnXwBeWSH7Gd2uNKAnQ== X-YMail-OSG: UYLJTw0VM1nRSoIjO.3qwfriqSFacknAfwtjVFiMxSxR8MOPQCX68Jv9hiMd93Y B.AAGV5vlsCpKr8G1YagRFVMRVMYWj8RCD3E.Kw6S4_Z6cu7pZKrKLXozZBMQWYN1aFOaGUQpfSd lZKtbxFrpU.PItPRxtvZ0UzDfIwZIYyb4dxQ3OsYnPcwuhja8FsS9BqbtiEmThbTbFlhKlQRHYIG GFdjAZ0UZbBzgfrOLNM6ecTYZiNiyxx1.DrEUzEij832n1FpMTRRFGmhgEQ4N0IO1NiL0jLx4JrC zNjZrFSH3Ioh1RUAUNiMi08NTrFt7nhVLuwKhAU_TrsOUkqhq_vKfUM.z6qzma16uP0pNfKiyjyQ 4DGnZOwNlrc6IRwLn.Dg11oCCdwsZO1zpVQIJNEcKHe.JZfcMTt.IqziZIUVcxR2FHpCPnhcm.fJ z4KgLZyumzBx_tizjxsopfVF3B.LE9mLuBJtwjx0tw7HOkYOFRE2P6xi1JtwkVws0ujeK.IZ9RTq z26ksF0MeCA15_EB92uJ0DK6PpHEp5_POCd4uEx6LxDJJFEa7.iQqvFYPLeFRmcUegbP2bOfnVUP rAy0KhSentj6AFLr6ybRcjz5VtRNI10EZ9E5e0aHA.cXc8_G4PfjrtDWe0PM_XoX1y6ZTAZHt5ZD K7VImG9_P64KRP63Laqn.mn_VzcoPyaVnFZOa0k8g9keFjMT3QfiZhAVgOwhM25iwh_5V9Xs.zfS 5MQPDX2Kjg3c.fqp0ufCBd13KkxbePVyPuBJp0K0Mfktdwr28_FatynHvAQYdbCu3Aic7.G_UnV_ mUZbOV9RZM4TIBmE0rysLiFKNdiN8tPW11_sn5oJmF X-Sonic-MF: X-Sonic-ID: 8fa9f47c-0970-4c14-8286-b6e5f5df5a92 Original-Received: from sonic.gate.mail.ne1.yahoo.com by sonic303.consmr.mail.ne1.yahoo.com with HTTP; Wed, 24 Jan 2024 12:05:07 +0000 Original-Received: by hermes--production-sg3-677476f564-v8kl6 (Yahoo Inc. Hermes SMTP Server) with ESMTPA ID 17609be186862b43b992ccee14f74b7d; Wed, 24 Jan 2024 12:05:04 +0000 (UTC) In-Reply-To: (Stefan Kangas's message of "Wed, 24 Jan 2024 02:15:12 -0800") X-Mailer: WebService/1.1.22046 mail.backend.jedi.jws.acl:role.jedi.acl.token.atz.jws.hermes.yahoo X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:278775 Archived-At: Stefan Kangas writes: > Subject: [PATCH] * lisp/net/dictionary.el: satisfy checkdoc > > (dictionary-tool-bar-map): add missing period > (dictionary-process-popup-replies), > (dictionary-read-definition), > (dictionary-display-tooltip): rename ignored parameters > (dictionary-tooltip-track-mouse): describe what function does, not just when > (dictionary-switch-tooltip-mode): reword docstring in terms of ON parameter Thanks. Nowayman, we cannot install this as-is, since the formatting of the commit message does not meet our standards. Please capitalize the first character in each sentence, punctuate sentences with periods followed by two spaces, and either omit commas after the identifiers in entries sharing a description or move such identifiers into a single line and pair of parentheses, provided that such line totals fewer than 64 columns. I find that a surprising number of individuals cannot produce correctly formatted entries on the first attempt. Is the layout of our documentation part of the problem? We should consider why the 124-odd lines' worth of advice in CONTRIBUTE are being overlooked by most new hands whose patches turn up in this list, and even some old ones, because correcting improperly formatted patches individually gets old fast.