]> git.eshelyaron.com Git - emacs.git/commitdiff
* etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention
authorChristopher Schmidt <christopher@ch.ristopher.com>
Mon, 15 Apr 2013 17:01:00 +0000 (19:01 +0200)
committerChristopher Schmidt <christopher@ch.ristopher.com>
Mon, 15 Apr 2013 17:01:00 +0000 (19:01 +0200)
separation of package descriptor and name of internal symbols by
two hyphens.

doc/lispref/ChangeLog
doc/lispref/tips.texi
etc/ChangeLog
etc/NEWS

index f65c2e854614ed671fa034e68352612a0cb61eb1..31e4f7913503ed6d8c2edd364a53eedca53fc716 100644 (file)
@@ -1,3 +1,8 @@
+2013-04-15  Christopher Schmidt  <christopher@ch.ristopher.com>
+
+       * tips.texi (Coding Conventions): Mention separation of package
+       descriptor and name of internal symbols by two hyphens.
+
 2013-04-13  Stephen Berman  <stephen.berman@gmx.net>
 
        * windows.texi (Splitting Windows): Change category of
index 4c443da3af81248d03d2385e204b0ecd571c9b4b..c40ae408f7f0890aaf90478aeb29b79dbae97609 100644 (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
index 31d14b96d94868bea63c0c0f75f0b06b1a49caba..2b7534dc1e73d116ad60765670c8d66e87304b05 100644 (file)
@@ -1,3 +1,8 @@
+2013-04-15  Christopher Schmidt  <christopher@ch.ristopher.com>
+
+       * NEWS: Mention separation of package descriptor and name of
+       internal symbols by two hyphens.
+
 2013-04-13  Stephen Berman  <stephen.berman@gmx.net>
 
        * NEWS: Mention fixing `split-window' to be non-interactive.
index 1e072afaaf10bed99ab60cb53cfd1ce9db502cf0..0830a7be469edfa765645007b80b88b8640767fa 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -409,6 +409,12 @@ used in place of the 9th element of `file-attributes'.
 `preserve-extended-attributes' as it now handles both SELinux context
 and ACL entries.
 
+** Changes to the Emacs Lisp Coding Conventions in Emacs 24.4
+
+*** The package descriptor and name of global variables, constants,
+and functions should be separated by two hypens if the symbol is not
+meant to be used by other packages.
+
 \f
 * Changes in Emacs 24.4 on Non-Free Operating Systems