From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 14 Jun 2018 13:54:08 +0000 (+0300)
Subject: Improve commentary in info.el
X-Git-Tag: emacs-26.1.90~361
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a933ebef57cde64c90fd6d92ae34eabd705f100a;p=emacs.git

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.
---

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))