From: Emanuel Berg <incal@dataswamp.org>
To: help-gnu-emacs@gnu.org
Subject: Re: elisp--curent-symbol question
Date: Tue, 15 Nov 2022 03:47:05 +0100 [thread overview]
Message-ID: <87v8nh0w9i.fsf@dataswamp.org> (raw)
In-Reply-To: AM9PR09MB4977CD669C5F8AC732F8BCEF96059@AM9PR09MB4977.eurprd09.prod.outlook.com
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
prev parent reply other threads:[~2022-11-15 2:47 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-14 6:00 elisp--curent-symbol question Arthur Miller
2022-11-15 2:47 ` Emanuel Berg [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87v8nh0w9i.fsf@dataswamp.org \
--to=incal@dataswamp.org \
--cc=help-gnu-emacs@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).