aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Schmidt2013-06-26 17:22:21 +0200
committerChristopher Schmidt2013-06-26 17:22:21 +0200
commitbace80138586ec3d166baaa511eced3fb54d040b (patch)
treefadd6b6832d86014f1878692c315a2bcf1dcf876
parent23a75d7f5957aef1b8bbbf07672596d0535a7c27 (diff)
downloademacs-bace80138586ec3d166baaa511eced3fb54d040b.tar.gz
emacs-bace80138586ec3d166baaa511eced3fb54d040b.zip
* tips.texi (Coding Conventions): Improve wording.
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/tips.texi12
2 files changed, 10 insertions, 6 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 0b94ad66bf0..e18db97c73b 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12013-06-26 Christopher Schmidt <christopher@ch.ristopher.com>
2
3 * tips.texi (Coding Conventions): Improve wording.
4
12013-06-24 Glenn Morris <rgm@gnu.org> 52013-06-24 Glenn Morris <rgm@gnu.org>
2 6
3 * loading.texi (Autoload): Fix typo. 7 * loading.texi (Autoload): Fix typo.
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index c40ae408f7f..2e3760e573e 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -54,12 +54,12 @@ You should choose a short word to distinguish your program from other
54Lisp programs. The names of all global symbols in your program, that 54Lisp programs. The names of all global symbols in your program, that
55is the names of variables, constants, and functions, should begin with 55is the names of variables, constants, and functions, should begin with
56that chosen prefix. Separate the prefix from the rest of the name 56that chosen prefix. Separate the prefix from the rest of the name
57with a hyphen, @samp{-}. Use two hyphens if the symbol is not meant 57with a hyphen, @samp{-}. This practice helps avoid name conflicts,
58to be used by other packages. This practice helps avoid name 58since all global variables in Emacs Lisp share the same name space,
59conflicts, since all global variables in Emacs Lisp share the same 59and all functions share another name space@footnote{The benefits of a
60name space, and all functions share another name space@footnote{The 60Common Lisp-style package system are considered not to outweigh the
61benefits of a Common Lisp-style package system are considered not to 61costs.}. Use two hyphens to separate prefix and name if the symbol is
62outweigh the costs.}. 62not meant to be used by other packages.
63 63
64Occasionally, 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
65convenient if some words come before the package's name prefix. And 65convenient if some words come before the package's name prefix. And