summaryrefslogtreecommitdiff
path: root/lisp/info.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-06-14 16:54:08 +0300
committerEli Zaretskii <eliz@gnu.org>2018-06-14 16:54:08 +0300
commita933ebef57cde64c90fd6d92ae34eabd705f100a (patch)
tree777f3fbbdc1e1953cfc3b33ac234118a340092dd /lisp/info.el
parent94e84a92fee4f7015ceedc0e39c767d72facb0e2 (diff)
downloademacs-a933ebef57cde64c90fd6d92ae34eabd705f100a.tar.gz
Improve commentary in info.el
* lisp/info.el: Explain in commentary why some commands start with "info-" and others with "Info-". See also http://lists.gnu.org/archive/html/emacs-devel/2017-11/msg00482.html.
Diffstat (limited to 'lisp/info.el')
-rw-r--r--lisp/info.el9
1 files changed, 9 insertions, 0 deletions
diff --git a/lisp/info.el b/lisp/info.el
index 8743b449976..30df4bfe5c1 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -30,6 +30,15 @@
;; This distinction is to support indexing of computer programming
;; language terms that may contain ":" but not ": ".
+;; The commands in this file should start either with "Info-" or with
+;; "info-". The capitalized version is for commands that are bound to
+;; keys, and therefore are unlikely to be invoked by name via "M-x";
+;; the lower-case version is for commands invoked by name. This
+;; arrangement makes completion of "info-" commands work better,
+;; because the "Info-" commands (of which there are a lot) don't get
+;; in the way. Please adhere to this convention when you add commands
+;; here.
+
;;; Code:
(eval-when-compile (require 'cl-lib))