From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Naming internal functions Date: Mon, 15 Apr 2013 17:07:24 +0300 Message-ID: <83zjwz6g6b.fsf@gnu.org> References: <87hajhswdh.fsf@gmail.com> <87y5csu7ml.fsf@gmail.com> <87zjx8ivyb.fsf_-_@earth.home> <87li8joqil@ch.ristopher.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1366034868 22272 80.91.229.3 (15 Apr 2013 14:07:48 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 15 Apr 2013 14:07:48 +0000 (UTC) Cc: emacs-devel@gnu.org To: Christopher Schmidt Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 15 16:07:52 2013 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1URk4V-0000P4-FW for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2013 16:07:51 +0200 Original-Received: from localhost ([::1]:42858 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URk4U-0003rv-Ug for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2013 10:07:50 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:47268) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URk4M-0003a0-KU for emacs-devel@gnu.org; Mon, 15 Apr 2013 10:07:47 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1URk4H-0004dK-Kt for emacs-devel@gnu.org; Mon, 15 Apr 2013 10:07:42 -0400 Original-Received: from mtaout22.012.net.il ([80.179.55.172]:57712) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1URk4H-0004cu-9f for emacs-devel@gnu.org; Mon, 15 Apr 2013 10:07:37 -0400 Original-Received: from conversion-daemon.a-mtaout22.012.net.il by a-mtaout22.012.net.il (HyperSendmail v2007.08) id <0MLA00000V3J9200@a-mtaout22.012.net.il> for emacs-devel@gnu.org; Mon, 15 Apr 2013 17:07:14 +0300 (IDT) Original-Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout22.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MLA0004AV821380@a-mtaout22.012.net.il>; Mon, 15 Apr 2013 17:07:14 +0300 (IDT) In-reply-to: <87li8joqil@ch.ristopher.com> X-012-Sender: halo1@inter.net.il X-detected-operating-system: by eggs.gnu.org: Solaris 10 X-Received-From: 80.179.55.172 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:158927 Archived-At: > From: Christopher Schmidt > Date: Mon, 15 Apr 2013 14:46:26 +0100 (BST) > > > Sounds good, tho a suggested patch would be welcome. > > --- doc/lispref/tips.texi > +++ doc/lispref/tips.texi Thanks! > 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. ^^^^^^^^^^ What "object"? This word was never mentioned in the preceding text, so using it here will confuse, especially those readers whose first language is not English. Never introduce new terminology in the middle of a complex description, where each successive sentence builds upon what the preceding ones said. Always use _exactly_ the same words as in the preceding sentences. If you need to introduce a new word, always describe it first. For example: The names of any global objects---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{-}. Use two hyphens if the object is not meant to be used by other packages. (Not that I think "objects" is good terminology in this context, but just to show you the principle.) > --- 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. Same here.