From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 32970@debbugs.gnu.org
Subject: bug#32970: 26; doc string of `this-command-keys-vector' (minor)
Date: Thu, 11 Jul 2019 17:55:35 +0200 [thread overview]
Message-ID: <87ef2w36rs.fsf@mouse.gnus.org> (raw)
In-Reply-To: <d8f6576e-5465-4ef4-8775-2a19cb393403@default> (Drew Adams's message of "Sun, 7 Oct 2018 15:00:14 +0000 (UTC)")
Drew Adams <drew.adams@oracle.com> writes:
> 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.
The current help buffer is:
--
this-command-keys-vector is a built-in function in ‘src/keyboard.c’.
(this-command-keys-vector)
This function does not change global state, including the match data.
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’.
--
So this has been fixed.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2019-07-11 15:55 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-07 15:00 bug#32970: 26; doc string of `this-command-keys-vector' (minor) Drew Adams
2019-07-11 15:55 ` Lars Ingebrigtsen [this message]
2019-07-11 17:11 ` Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ef2w36rs.fsf@mouse.gnus.org \
--to=larsi@gnus.org \
--cc=32970@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).