GNU bug report logs - #32970
26; doc string of `this-command-keys-vector' (minor)

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26; doc string of `this-command-keys-vector' (minor)
Date: Sun, 7 Oct 2018 15:00:14 +0000 (UTC)

Doc string:

  this-command-keys-vector is a built-in function in 'C source code'.

  (this-command-keys-vector)

  Return the key sequence that invoked this command, as a vector.
  However, if the command has called 'read-key-sequence', it returns
  the last key sequence that has been read.

  See also 'this-command-keys'.
  This function does not change global state, including the match data.

It would be clearer, I think, if the order of the last two sentences
were reversed.  And perhaps they should not even be in the same
paragraph.  The current order can lead to thinking that "this function"
means `this-command-keys', and that it is only `this-command-keys', not
also `this-command-keys-vector', that does not change global state.

In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 10.0.16299
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.