changeset 43271:a8329a91e9b5

(Fthis_command_keys, Fthis_command_keys_vector) (Fthis_single_command_keys, Fthis_single_command_raw_keys) (Fclear_this_command_keys): Doc fixes.
author Richard M. Stallman <rms@gnu.org>
date Wed, 13 Feb 2002 16:23:08 +0000
parents 935816913346
children d05b5e007830
files src/keyboard.c
diffstat 1 files changed, 10 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/keyboard.c	Wed Feb 13 16:21:07 2002 +0000
+++ b/src/keyboard.c	Wed Feb 13 16:23:08 2002 +0000
@@ -9623,6 +9623,8 @@
 
 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
        doc: /* Return the key sequence that invoked this command.
+However, if the command has called `read-key-sequence', it returns
+the the last key sequence that has been read.
 The value is a string or a vector.  */)
      ()
 {
@@ -9631,7 +9633,9 @@
 }
 
 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
-       doc: /* Return the key sequence that invoked this command, as a vector.  */)
+       doc: /* Return the key sequence that invoked this command, as a vector.
+However, if the command has called `read-key-sequence', it returns
+the the last key sequence that has been read.  */)
      ()
 {
   return Fvector (this_command_key_count,
@@ -9641,6 +9645,8 @@
 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
        Sthis_single_command_keys, 0, 0, 0,
        doc: /* Return the key sequence that invoked this command.
+More generally, it returns the last key sequence read, either by
+the command loop or by `read-key-sequence'.
 Unlike `this-command-keys', this function's value
 does not include prefix arguments.
 The value is always a vector.  */)
@@ -9655,6 +9661,8 @@
 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
        Sthis_single_command_raw_keys, 0, 0, 0,
        doc: /* Return the raw events that were read for this command.
+More generally, it returns the last key sequence read, either by
+the command loop or by `read-key-sequence'.
 Unlike `this-single-command-keys', this function's value
 shows the events before all translations (except for input methods).
 The value is always a vector.  */)
@@ -9688,7 +9696,7 @@
 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
        Sclear_this_command_keys, 0, 0, 0,
        doc: /* Clear out the vector that `this-command-keys' returns.
-Clear vector containing last 100 events.  */)
+Also clear the record of the last 100 events.  */)
      ()
 {
   int i;