GNU bug report logs - #65512
30.0.50; Docstring current-idle-time: PSEC?

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 65512 in the body.
You can then email your comments to 65512 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 30.0.50; Docstring current-idle-time: PSEC?
Date: Fri, 25 Aug 2023 05:27:41 +0200

Hello,

C-h f current-idle-time
| Return the current length of Emacs idleness, or nil.
| [...]
| PSEC is a multiple of the system clock resolution.

But PSEC is not an argument of that function and appears nowhere else in
the docstring.

TIA,

Michael.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 65512 <at> debbugs.gnu.org
Subject: Re: bug#65512: 30.0.50; Docstring current-idle-time: PSEC?
Date: Fri, 25 Aug 2023 08:54:43 +0300

> From: Michael Heerdegen <michael_heerdegen <at> web.de>
> Date: Fri, 25 Aug 2023 05:27:41 +0200
> 
> C-h f current-idle-time
> | Return the current length of Emacs idleness, or nil.
> | [...]
> | PSEC is a multiple of the system clock resolution.
> 
> But PSEC is not an argument of that function and appears nowhere else in
> the docstring.

PSEC is not an argument, it's the last member of a 4-member list.  I
hope I've clarified this now in the doc string.

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

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 65512 <at> debbugs.gnu.org
Subject: Re: bug#65512: 30.0.50; Docstring current-idle-time: PSEC?
Date: Sat, 26 Aug 2023 01:04:01 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> PSEC is not an argument, it's the last member of a 4-member list.  I
> hope I've clarified this now in the doc string.

Thanks.

Is there a reason why we mention this detail that's also in the
`current-time' docstring, but not others?  With other words: could we
just remove the mention of PSEC?  Just wondering.

Thx,

Michael.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 65512 <at> debbugs.gnu.org
Subject: Re: bug#65512: 30.0.50; Docstring current-idle-time: PSEC?
Date: Sat, 26 Aug 2023 08:28:32 +0300

> From: Michael Heerdegen <michael_heerdegen <at> web.de>
> Cc: 65512 <at> debbugs.gnu.org
> Date: Sat, 26 Aug 2023 01:04:01 +0200
> 
> Is there a reason why we mention this detail that's also in the
> `current-time' docstring, but not others?  With other words: could we
> just remove the mention of PSEC?  Just wondering.

In general, the 4-member list doesn't have to satisfy that condition,
and the doc string refers to current-time only for the possible
formats of the value, not for anything else.

Also, this remark was always in the doc string of current-idle-time,
so it's possible it is important to some applications.  So IMO we
should leave that there.

Message #19 received at 65512-done <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 65512-done <at> debbugs.gnu.org
Subject: Re: bug#65512: 30.0.50; Docstring current-idle-time: PSEC?
Date: Sun, 27 Aug 2023 06:17:53 +0200

Hello Eli,

ok, in that case thank you for your fix.  I'm closing this bug.

Michael.

Previous Next

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