From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 24829@debbugs.gnu.org
Subject: bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention
Date: Sat, 27 Jul 2019 14:50:50 +0200 [thread overview]
Message-ID: <871rybiqtx.fsf@mouse.gnus.org> (raw)
In-Reply-To: <787c4f0e-4cd2-46b9-9e7a-1cc694e8b71c@default> (Drew Adams's message of "Sun, 30 Oct 2016 15:50:43 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> Macro `easy-mmode-define-navigation' apparently defines Emacs commands
> (functions). Per the Emacs Lisp coding conventions, its seems that the
> macro should be renamed.
>
>>From (elisp `Coding Conventions':
>
> Constructs that define a function or variable should be macros, not
> functions, and their names should start with `define-'. The macro
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> should receive the name to be defined as the first argument. That
> will help various tools find the definition automatically. Avoid
> constructing the names in the macro itself, since that would
> confuse these tools.
I'm not sure how much of an edict that's supposed to be.
easy-mmode has other functions/macros using the same naming convention
(like easy-mmode-define-syntax), but those don't define functions, of
course.
We could change easy-mmode-define-navigation to, say,
`define-easy-mmode-navigation', but I'm not sure that would be a net
win, confusion wise. Anybody have an opinion here?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2019-07-27 12:50 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-30 22:50 bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention Drew Adams
2019-07-27 12:50 ` Lars Ingebrigtsen [this message]
2020-08-12 0:46 ` Stefan Kangas
2020-08-12 10:51 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871rybiqtx.fsf@mouse.gnus.org \
--to=larsi@gnus.org \
--cc=24829@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.