GNU bug report logs - #27996
open-dribble-file docstring improvement

Previous Next

Package: emacs;

Reported by: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>

Date: Mon, 7 Aug 2017 02:13:03 UTC

Severity: wishlist

Tags: fixed

Fixed in version 27.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#27996; Package emacs. (Mon, 07 Aug 2017 02:13:03 GMT) Full text and rfc822 format available.
Acknowledgement sent to 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 07 Aug 2017 02:13:04 GMT) Full text and rfc822 format available.

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

From: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
To: bug-gnu-emacs <at> gnu.org
Subject: open-dribble-file docstring improvement
Date: Mon, 07 Aug 2017 08:56:36 +0800

open-dribble-file is an interactive built-in function in ‘C source code’.

> Start writing all keyboard characters to a dribble file called FILE.
> If FILE is nil, close any open dribble file.
> The file will be closed when Emacs exits.

On the last line I would say

< Else the file will be closed when Emacs exits.

as some readers wouldn't notice the second line as that is just talking
about parameters.

Also mention how often it is written. Every keystroke? Every newline?
Also when one does C-x C-s etc.
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#27996; Package emacs. (Mon, 15 Jul 2019 17:57:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Cc: 27996 <at> debbugs.gnu.org
Subject: Re: bug#27996: open-dribble-file docstring improvement
Date: Mon, 15 Jul 2019 19:56:03 +0200

積丹尼 Dan Jacobson <jidanni <at> jidanni.org> writes:

> open-dribble-file is an interactive built-in function in ‘C source code’.
>
>> Start writing all keyboard characters to a dribble file called FILE.
>> If FILE is nil, close any open dribble file.
>> The file will be closed when Emacs exits.
>
> On the last line I would say
>
> < Else the file will be closed when Emacs exits.
>
> as some readers wouldn't notice the second line as that is just talking
> about parameters.
>
> Also mention how often it is written. Every keystroke? Every newline?

I've now clarified these two things.

> Also when one does C-x C-s etc.

But not that thing, because it's superfluous.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 15 Jul 2019 17:57:02 GMT) Full text and rfc822 format available.
bug marked as fixed in version 27.1, send any further explanations to 27996 <at> debbugs.gnu.org and 積丹尼 Dan Jacobson <jidanni <at> jidanni.org> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 15 Jul 2019 17:57:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Tue, 13 Aug 2019 11:24:10 GMT) Full text and rfc822 format available.
This bug report was last modified 4 years and 258 days ago.

Previous Next

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