Re: Naming internal functions

[Christopher Schmidt <christopher@ch.ristopher.com>]

[-- Attachment #1: Type: text/plain, Size: 312 bytes --]

Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> I would like to propose a tweak to the prefix convention.
>>     (info "(elisp)Coding Conventions")
>> Let's separate package and name of internal functions or variables
>> with two consecutive dashes.
>
> Sounds good, tho a suggested patch would be welcome.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-diff, Size: 1327 bytes --]

--- doc/lispref/tips.texi
+++ doc/lispref/tips.texi
@@ -54,9 +54,10 @@
 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
+Use two hyphens if the object 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
--- etc/NEWS
+++ etc/NEWS
@@ -409,6 +409,12 @@
 `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 object is not
+meant to be used by other packages.
+
 \f
 * Changes in Emacs 24.4 on Non-Free Operating Systems
 

[-- Attachment #3: Type: text/plain, Size: 21 bytes --]


        Christopher