emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master f80fd09: * doc/lispref/tips.texi (Coding Conventions): Mention GN


From: Stefan Monnier
Subject: master f80fd09: * doc/lispref/tips.texi (Coding Conventions): Mention GNU "path" convention
Date: Sun, 7 Nov 2021 01:11:35 -0400 (EDT)

branch: master
commit f80fd099fc6653c9893b5522c0d520c0ae1f5133
Author: Stefan Monnier <monnier@iro.umontreal.ca>
Commit: Stefan Monnier <monnier@iro.umontreal.ca>

    * doc/lispref/tips.texi (Coding Conventions): Mention GNU "path" convention
    
    Suggested by Ihor Radchenko <yantar92@gmail.com>.
---
 doc/lispref/tips.texi | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index fa764f1..cbfcbd8 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -252,6 +252,13 @@ themselves; Lisp programmers find this disconcerting.
 Please put a copyright notice and copying permission notice on the
 file if you distribute copies.  @xref{Library Headers}.
 
+@item
+For variables holding (or functions returning) a file or directory name,
+avoid using @code{path} in its name, preferring @code{file},
+@code{file-name}, or @code{directory} instead, since Emacs follows the
+GNU convention to use the term @emph{path} only for search paths,
+which are lists of directory names.
+
 @end itemize
 
 @node Key Binding Conventions



reply via email to

[Prev in Thread] Current Thread [Next in Thread]