From: Stefan Kangas Date: Mon, 27 Dec 2021 15:24:18 +0000 (+0100) Subject: Doc fix; fix terminology in key binding functions X-Git-Tag: emacs-29.0.90~3416 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8df3a71c526c28b17926f7b56860f9798ab6d933;p=emacs.git Doc fix; fix terminology in key binding functions * lisp/keymap.el (keymap-set, key-valid-p): * lisp/subr.el (define-keymap): Doc fix; improve terminology. --- diff --git a/lisp/keymap.el b/lisp/keymap.el index fd91689f887..734cbe89cd1 100644 --- a/lisp/keymap.el +++ b/lisp/keymap.el @@ -38,7 +38,7 @@ (byte-compile-warn "Invalid `kbd' syntax: %S" key)))) (defun keymap-set (keymap key definition) - "Set key sequence KEY to DEFINITION in KEYMAP. + "Set KEY to DEFINITION in KEYMAP. KEY is a string that satisfies `key-valid-p'. DEFINITION is anything that can be a key's definition: @@ -295,9 +295,9 @@ See `kbd' for a descripion of KEYS." res)))) (defun key-valid-p (keys) - "Say whether KEYS is a valid `kbd' sequence. -A `kbd' sequence is a string consisting of one and more key -strokes. The key strokes are separated by a space character. + "Say whether KEYS is a valid key. +A key is a string consisting of one or more key strokes. +The key strokes are separated by a space character. Each key stroke is either a single character, or the name of an event, surrounded by angle brackets. In addition, any key stroke diff --git a/lisp/subr.el b/lisp/subr.el index b77afaca944..29f375884b0 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -6549,7 +6549,7 @@ not a list, return a one-element list containing OBJECT." form) (defun define-keymap (&rest definitions) - "Create a new keymap and define KEY/DEFINITION pairs as key sequences. + "Create a new keymap and define KEY/DEFINITION pairs as key bindings. The new keymap is returned. Options can be given as keywords before the KEY/DEFINITION