mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 18:40:39 -08:00
Code Issues Projects Releases Wiki Activity

* etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention

Browse source 
separation of package descriptor and name of internal symbols by
two hyphens.
This commit is contained in:
Christopher Schmidt 2013-04-15 19:01:00 +02:00
parent 20e527d0c5
commit 8fa2654ed8
4 changed files with 25 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/lispref/tips.texi
View file

@ -51,13 +51,15 @@ don't postpone it.
@item
You should choose a short word to distinguish your program from other
Lisp programs. The names of all global variables, constants, and
functions in your program should begin with that chosen prefix.
Separate the prefix from the rest of the name with a hyphen, @samp{-}.
This practice helps avoid name conflicts, since all global variables
in Emacs Lisp share the same name space, and all functions share
another name space@footnote{The benefits of a Common Lisp-style
package system are considered not to outweigh the costs.}.
Lisp programs. The names of all global symbols in your program, that
is the names of variables, constants, and functions, should begin with
that chosen prefix. Separate the prefix from the rest of the name
with a hyphen, @samp{-}. Use two hyphens if the symbol is not meant
to be used by other packages. This practice helps avoid name
conflicts, since all global variables in Emacs Lisp share the same
name space, and all functions share another name space@footnote{The
benefits of a Common Lisp-style package system are considered not to
outweigh the costs.}.
Occasionally, for a command name intended for users to use, it is more
convenient if some words come before the package's name prefix. And