From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#32970: 26; doc string of `this-command-keys-vector' (minor) Date: Thu, 11 Jul 2019 17:55:35 +0200 Message-ID: <87ef2w36rs.fsf@mouse.gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="112069"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 32970@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Jul 11 17:56:07 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hlbQU-000T0U-Us for geb-bug-gnu-emacs@m.gmane.org; Thu, 11 Jul 2019 17:56:07 +0200 Original-Received: from localhost ([::1]:43002 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hlbQT-0002Ou-Nu for geb-bug-gnu-emacs@m.gmane.org; Thu, 11 Jul 2019 11:56:05 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:32860) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hlbQR-0002NU-AR for bug-gnu-emacs@gnu.org; Thu, 11 Jul 2019 11:56:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hlbQQ-0005Ri-3j for bug-gnu-emacs@gnu.org; Thu, 11 Jul 2019 11:56:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57866) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hlbQP-0005Ra-WD for bug-gnu-emacs@gnu.org; Thu, 11 Jul 2019 11:56:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hlbQP-0006q2-SU for bug-gnu-emacs@gnu.org; Thu, 11 Jul 2019 11:56:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 11 Jul 2019 15:56:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 32970 X-GNU-PR-Package: emacs Original-Received: via spool by 32970-submit@debbugs.gnu.org id=B32970.156286054226243 (code B ref 32970); Thu, 11 Jul 2019 15:56:01 +0000 Original-Received: (at 32970) by debbugs.gnu.org; 11 Jul 2019 15:55:42 +0000 Original-Received: from localhost ([127.0.0.1]:38451 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hlbQ6-0006pB-9G for submit@debbugs.gnu.org; Thu, 11 Jul 2019 11:55:42 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:57086) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hlbQ4-0006p3-K0 for 32970@debbugs.gnu.org; Thu, 11 Jul 2019 11:55:41 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hlbPz-00053Y-Ls; Thu, 11 Jul 2019 17:55:38 +0200 In-Reply-To: (Drew Adams's message of "Sun, 7 Oct 2018 15:00:14 +0000 (UTC)") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:162715 Archived-At: Drew Adams 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 =E2=80=98src/keyboard.c= =E2=80=99. (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 =E2=80=98read-key-sequence=E2=80=99, it = returns the last key sequence that has been read. See also =E2=80=98this-command-keys=E2=80=99. -- So this has been fixed. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no