# HG changeset patch
# User Gerd Moellmann <gerd@gnu.org>
# Date 958037286 0
# Node ID e62636f5d724e147cc8b07beb55337be29beac58
# Parent  48daf6eb57cd21a5a1fbc2543b280ec5dc2287b4
(substitute-key-definition): Add comment describing
the meaning of PREFIX.

diff -r 48daf6eb57cd -r e62636f5d724 lisp/subr.el
--- 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))