Mercurial > emacs

changeset 28868:e62636f5d724

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(substitute-key-definition): Add comment describing the meaning of PREFIX.
author Gerd Moellmann <gerd@gnu.org>
date Thu, 11 May 2000 09:28:06 +0000
parents 48daf6eb57cd
children 91b54118e73c
files lisp/subr.el
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/subr.el	Thu May 11 08:31:26 2000 +0000
+++ b/lisp/subr.el	Thu May 11 09:28:06 2000 +0000
@@ -228,6 +228,13 @@
 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
 in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP."
+  ;; Don't document PREFIX in the doc string because we don't want to
+  ;; advertise it.  It's meant for recursive calls only.  Here's its
+  ;; meaning
+  
+  ;; If optional argument PREFIX is specified, it should be a key
+  ;; prefix, a string.  Redefined bindings will then be bound to the
+  ;; original key, with PREFIX added at the front.
   (or prefix (setq prefix ""))
   (let* ((scan (or oldmap keymap))
 	 (vec1 (vector nil))