aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristopher Schmidt2013-04-15 19:01:00 +0200
committerChristopher Schmidt2013-04-15 19:01:00 +0200
commit8fa2654ed8fd2118b8a3120e2b4f9857e6a96239 (patch)
tree9febe12fa205446352e43c52bd85943177d6a078 /doc
parent20e527d0c5e5a4ba95f14ab1d0379c20557406ae (diff)
downloademacs-8fa2654ed8fd2118b8a3120e2b4f9857e6a96239.tar.gz
emacs-8fa2654ed8fd2118b8a3120e2b4f9857e6a96239.zip
* etc/NEWS, doc/lispref/tips.texi (Coding Conventions): Mention
separation of package descriptor and name of internal symbols by two hyphens.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog5
-rw-r--r--doc/lispref/tips.texi16
2 files changed, 14 insertions, 7 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index f65c2e85461..31e4f791350 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
12013-04-15 Christopher Schmidt <christopher@ch.ristopher.com>
2
3 * tips.texi (Coding Conventions): Mention separation of package
4 descriptor and name of internal symbols by two hyphens.
5
12013-04-13 Stephen Berman <stephen.berman@gmx.net> 62013-04-13 Stephen Berman <stephen.berman@gmx.net>
2 7
3 * windows.texi (Splitting Windows): Change category of 8 * windows.texi (Splitting Windows): Change category of
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 4c443da3af8..c40ae408f7f 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -51,13 +51,15 @@ don't postpone it.
51 51
52@item 52@item
53You should choose a short word to distinguish your program from other 53You should choose a short word to distinguish your program from other
54Lisp programs. The names of all global variables, constants, and 54Lisp programs. The names of all global symbols in your program, that
55functions in your program should begin with that chosen prefix. 55is the names of variables, constants, and functions, should begin with
56Separate the prefix from the rest of the name with a hyphen, @samp{-}. 56that chosen prefix. Separate the prefix from the rest of the name
57This practice helps avoid name conflicts, since all global variables 57with a hyphen, @samp{-}. Use two hyphens if the symbol is not meant
58in Emacs Lisp share the same name space, and all functions share 58to be used by other packages. This practice helps avoid name
59another name space@footnote{The benefits of a Common Lisp-style 59conflicts, since all global variables in Emacs Lisp share the same
60package system are considered not to outweigh the costs.}. 60name space, and all functions share another name space@footnote{The
61benefits of a Common Lisp-style package system are considered not to
62outweigh the costs.}.
61 63
62Occasionally, for a command name intended for users to use, it is more 64Occasionally, for a command name intended for users to use, it is more
63convenient if some words come before the package's name prefix. And 65convenient if some words come before the package's name prefix. And