bug#46899: 28.0.50; Inconsistency in Elisp manual section Emacs Lisp Coding Conventions

[Lars Ingebrigtsen]

"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