masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-04 11:23:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update remarks on name prefixes in coding conventions

Browse source 
* doc/lispref/tips.texi (Coding Conventions): Say that it's okay
to put the name prefix later for defining constructs, rather
than explicitly instructing the reader to do so.  Condense the
recommendation to err on the side of prepending the name prefix.
This commit is contained in:
Sean Whitton 2025-04-12 11:05:45 +08:00
parent e966ff9759
commit 3f06059730
1 changed files with 7 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/lispref/tips.texi
View file

@ -73,18 +73,13 @@ not meant to be used by other packages.
Occasionally, for a command name intended for users to use, it is more Occasionally, for a command name intended for users to use, it is more
convenient if some words come before the package's name prefix. For convenient if some words come before the package's name prefix. For
example, it is our convention to have commands that list objects named example, it is our convention to have commands that list objects named
as @samp{list-@var{something}}, e.g., a package called @samp{frob} as @samp{list-@var{something}}, e.g., a package called @samp{frob} could
could have a command @samp{list-frobs}, when its other global symbols have a command @samp{list-frobs}, when its other global symbols begin
begin with @samp{frob-}. Also, constructs that define functions, with @samp{frob-}. Also, constructs that define functions, variables,
variables, etc., work better if they start with @samp{define-}, so put etc., may work better if they start with @samp{define-}, so it's okay to
the name prefix later on in the name. put the name prefix later on in the name. Outside of these
well-established cases, however, err on the side of prepending your name
This recommendation applies even to names for traditional Lisp prefix.
primitives that are not primitives in Emacs Lisp---such as
@code{copy-list}. Believe it or not, there is more than one plausible
way to define @code{copy-list}. Play it safe; append your name prefix
to produce a name like @code{foo-copy-list} or @code{mylib-copy-list}
instead.
If you write a function that you think ought to be added to Emacs under If you write a function that you think ought to be added to Emacs under
a certain name, such as @code{twiddle-files}, don't call it by that name a certain name, such as @code{twiddle-files}, don't call it by that name