From: Robert Pluim <rpluim@gmail.com>
Date: Fri, 17 Jan 2025 08:44:32 +0000 (+0100)
Subject: Improve 'key-valid-p' docstring
X-Git-Tag: archive/raspbian/1%30.1+1-3+rpi1^2~2^2~20^2~108
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=0e3687e6006ea93603a032056c6af99a242c6af5;p=emacs.git

Improve 'key-valid-p' docstring

* lisp/keymap.el (key-valid-p): Add "RET", "<return>", and "C-m"
examples.

(Bug#75586)
---

diff --git a/lisp/keymap.el b/lisp/keymap.el
index f74a84e8806..b2c7321a1d5 100644
--- a/lisp/keymap.el
+++ b/lisp/keymap.el
@@ -343,6 +343,9 @@ Here are some example of valid key sequences.
   \"C-c o\"       (a two-key sequence: the key `c' with the control modifier
                  followed by the key `o')
   \"H-<left>\"    (the cursor control key named \"left\" with the hyper modifier)
+  \"RET\"         (the \"return\" key, also available as \"C-m\")
+  \"<return>\"    (the \"<return>\" function key, which can be bound separately
+                 from \"RET\" on some systems)
   \"M-RET\"       (the \"return\" key with a meta modifier)
   \"C-M-<space>\" (the \"space\" key with both the control and meta modifiers)