From bace80138586ec3d166baaa511eced3fb54d040b Mon Sep 17 00:00:00 2001 From: Christopher Schmidt Date: Wed, 26 Jun 2013 17:22:21 +0200 Subject: [PATCH] * tips.texi (Coding Conventions): Improve wording. --- doc/lispref/ChangeLog | 4 ++++ doc/lispref/tips.texi | 12 ++++++------ 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 @@ +2013-06-26 Christopher Schmidt + + * tips.texi (Coding Conventions): Improve wording. + 2013-06-24 Glenn Morris * 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 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.}. +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.}. Use two hyphens to separate prefix and name if the symbol is +not meant to be used by other packages. 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 -- 2.39.2