From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg Newsgroups: gmane.emacs.help Subject: Re: elisp--curent-symbol question Date: Tue, 15 Nov 2022 03:47:05 +0100 Message-ID: <87v8nh0w9i.fsf@dataswamp.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16836"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: help-gnu-emacs@gnu.org Cancel-Lock: sha1:CYJw4/OzS2W5CZTDqzrHdQs3cJU= Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Nov 15 17:37:45 2022 Return-path: Envelope-to: geh-help-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 1ouywS-00045Q-IB for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 15 Nov 2022 17:37:44 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ouyvy-0008Ci-Rz; Tue, 15 Nov 2022 11:37:15 -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 1oulyo-00067g-Lf for help-gnu-emacs@gnu.org; Mon, 14 Nov 2022 21:47:18 -0500 Original-Received: from ciao.gmane.io ([116.202.254.214]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oulym-0006y2-8J for help-gnu-emacs@gnu.org; Mon, 14 Nov 2022 21:47:18 -0500 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1oulyj-0007Lo-9S for help-gnu-emacs@gnu.org; Tue, 15 Nov 2022 03:47:13 +0100 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: help-gnu-emacs@gnu.org Mail-Copies-To: never Received-SPF: pass client-ip=116.202.254.214; envelope-from=geh-help-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.249, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Tue, 15 Nov 2022 11:37:13 -0500 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.help:140971 Archived-At: Arthur Miller wrote: > Also the comment seem to belong to doc-string rather than > a comment outside the function. Same follows for some other > internal functions there, but that is a minor Yeah, but why do it incorrectly when it's so easy to do it right? Also, in elisp-mode.el in particular XD No, but practice on these: elisp-mode.el:283: Argument ‘interactive’ should appear (as INTERACTIVE) in the doc string elisp-mode.el:348: You should convert this comment to documentation elisp-mode.el:363: Argument ‘vars’ should appear (as VARS) in the doc string elisp-mode.el:466: Argument ‘pos’ should appear (as POS) in the doc string elisp-mode.el:1031: You should convert this comment to documentation elisp-mode.el:1281: Argument ‘end’ should appear (as END) in the doc string elisp-mode.el:1332: Argument ‘eval-last-sexp-arg-internal’ should appear (as EVAL-LAST-SEXP-ARG-INTERNAL) in the doc string elisp-mode.el:1559: Argument ‘eval-last-sexp-arg-internal’ should appear (as EVAL-LAST-SEXP-ARG-INTERNAL) in the doc string elisp-mode.el:1591: Argument ‘form’ should appear (as FORM) in the doc string elisp-mode.el:1691: Argument ‘edebug-it’ should appear (as EDEBUG-IT) in the doc string elisp-mode.el:1737: Second line should not have indentation elisp-mode.el:1769: Argument ‘callback’ should appear (as CALLBACK) in the doc string elisp-mode.el:1781: Argument ‘callback’ should appear (as CALLBACK) in the doc string elisp-mode.el:1792: Argument ‘callback’ should appear (as CALLBACK) in the doc string elisp-mode.el:1819: Argument ‘index’ should appear (as INDEX) in the doc string elisp-mode.el:1850: Arguments occur in the doc string out of order -- underground experts united https://dataswamp.org/~incal