From: Christopher Schmidt <christopher@ch.ristopher.com>
To: emacs-devel@gnu.org
Subject: Re: Naming internal functions
Date: Mon, 15 Apr 2013 14:46:26 +0100 (BST) [thread overview]
Message-ID: <87li8joqil@ch.ristopher.com> (raw)
In-Reply-To: <jwvfvz0vhl2.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Mon, 08 Apr 2013 17:28:46 -0400")
[-- 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
next prev parent reply other threads:[~2013-04-15 13:46 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-08 0:23 Modern Conventions for Emacs Lisp files? Thorsten Jolitz
2013-04-08 9:32 ` Alan Mackenzie
2013-04-08 20:05 ` Thorsten Jolitz
2013-04-08 13:22 ` Stefan Monnier
2013-04-08 13:54 ` Andreas Röhler
2013-04-08 19:51 ` Thorsten Jolitz
2013-04-09 6:05 ` Andreas Röhler
2013-04-08 19:47 ` Thorsten Jolitz
2013-04-08 20:07 ` Stefan Monnier
2013-04-08 20:37 ` Thorsten Jolitz
2013-04-08 21:26 ` Stefan Monnier
2013-04-08 22:21 ` Thorsten Jolitz
2013-04-09 7:29 ` Bastien
2013-04-09 12:27 ` Stefan Monnier
2013-04-09 13:11 ` Bastien
2013-04-09 13:36 ` Andreas Röhler
2013-04-09 13:41 ` Bastien
2013-04-13 23:41 ` Thorsten Jolitz
2013-04-14 0:24 ` Stefan Monnier
2013-04-14 3:06 ` Stefan Monnier
2013-04-14 8:16 ` Thorsten Jolitz
2013-04-15 8:37 ` Thorsten Jolitz
2013-04-15 9:04 ` Eli Zaretskii
2013-04-15 11:16 ` Thorsten Jolitz
2013-04-15 13:13 ` Stefan Monnier
2013-04-15 9:09 ` Bastien
2013-04-08 20:55 ` Naming internal functions (was: Modern Conventions for Emacs Lisp files?) Christopher Schmidt
2013-04-08 21:28 ` Naming internal functions Stefan Monnier
2013-04-15 13:46 ` Christopher Schmidt [this message]
2013-04-15 14:07 ` Eli Zaretskii
2013-04-15 14:14 ` Christopher Schmidt
2013-04-15 14:25 ` Eli Zaretskii
2013-04-15 17:08 ` Christopher Schmidt
2013-04-15 14:16 ` xfq
2013-04-08 22:41 ` Modern Conventions for Emacs Lisp files? Pascal J. Bourguignon
2013-04-08 23:42 ` Thorsten Jolitz
2013-04-09 2:11 ` Stefan Monnier
2013-04-09 8:04 ` Thorsten Jolitz
2013-04-09 12:23 ` Stefan Monnier
2013-04-10 19:06 ` Pascal J. Bourguignon
2013-04-10 20:04 ` Thorsten Jolitz
2013-04-09 9:18 ` Leo Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87li8joqil@ch.ristopher.com \
--to=christopher@ch.ristopher.com \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.