From: Lars Ingebrigtsen <larsi@gnus.org>
To: "Jorge P. de Morais Neto" <jorge+list@disroot.org>
Cc: 46899@debbugs.gnu.org
Subject: bug#46899: 28.0.50; Inconsistency in Elisp manual section Emacs Lisp Coding Conventions
Date: Thu, 04 Mar 2021 18:38:32 +0100 [thread overview]
Message-ID: <87mtvivmxz.fsf@gnus.org> (raw)
In-Reply-To: <877dmoqmvy.fsf@disroot.org> (Jorge P. de Morais Neto's message of "Wed, 03 Mar 2021 12:26:25 -0300")
"Jorge P. de Morais Neto" <jorge+list@disroot.org> writes:
> Hi. The section `Emacs Lisp Coding Conventions' (tips.texi) says:
>
> Also, constructs that define functions, variables, etc., work better
> if they start with @samp{defun} or @samp{defvar}, so put the name
> prefix later on in the name.
That is indeed puzzling -- I wasn't aware that we had any
package-specific macros starting with defun-, but indeed:
defun-rcirc-command defun-mh defun-cvs-mode
Uhm... and those are the only three in the Emacs tree, apparently?
> Therefore, developers are instructed to name these constructs starting
> with ~defun~ or ~defvar~. But a later paragraph says:
>
> Constructs that define a function or variable should be macros, not
> functions, and their names should start with @samp{define-}.
That sounds like what we're actually using.
I think removing the bit about defun/defvar might make the most sense
here (or just moving the define- thing up there). Opinions?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2021-03-04 17:38 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-03 15:26 bug#46899: 28.0.50; Inconsistency in Elisp manual section Emacs Lisp Coding Conventions Jorge P. de Morais Neto via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-03-04 17:38 ` Lars Ingebrigtsen [this message]
2021-03-06 5:21 ` Richard Stallman
2021-03-06 12:27 ` Lars Ingebrigtsen
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=87mtvivmxz.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=46899@debbugs.gnu.org \
--cc=jorge+list@disroot.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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
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).