GNU bug report logs - #31945
27.0.50; Readability of format docstring

Previous Next

Package: emacs;

Reported by: Andreas Röhler <andreas.roehler <at> easy-emacs.de>

Date: Sat, 23 Jun 2018 06:29:02 UTC

Severity: normal

Found in version 27.0.50

Done: Eli Zaretskii <eliz <at> gnu.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 31945 in the body.
You can then email your comments to 31945 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#31945; Package emacs. (Sat, 23 Jun 2018 06:29:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to Andreas Röhler <andreas.roehler <at> easy-emacs.de>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sat, 23 Jun 2018 06:29:02 GMT) Full text and rfc822 format available.

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

From: Andreas Röhler <andreas.roehler <at> easy-emacs.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50; Readability of format docstring
Date: Sat, 23 Jun 2018 08:30:57 +0200

C-h f format RET


Docu of format arguments starts commonly with argument in column 0.
%x however starts after comma inside a line:

"%s means print a string argument.  Actually, prints any object, with 
‘princ’.
%d means print as signed number in decimal.
%o means print as unsigned number in octal, %x as unsigned number in hex.
"

Suggest to move docu of %x to column zero too.
Maybe consider to sort arguments alphabetically.

In GNU Emacs 27.0.50 (build 1, i686-pc-linux-gnu, GTK+ Version 3.14.5)
 of 2018-05-29
Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Sat, 23 Jun 2018 12:36:02 GMT) Full text and rfc822 format available.
Notification sent to Andreas Röhler <andreas.roehler <at> easy-emacs.de>:
bug acknowledged by developer. (Sat, 23 Jun 2018 12:36:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Andreas Röhler <andreas.roehler <at> easy-emacs.de>
Cc: 31945-done <at> debbugs.gnu.org
Subject: Re: bug#31945: 27.0.50; Readability of format docstring
Date: Sat, 23 Jun 2018 15:35:41 +0300

> From: Andreas Röhler <andreas.roehler <at> easy-emacs.de>
> Date: Sat, 23 Jun 2018 08:30:57 +0200
> 
> C-h f format RET
> 
> 
> Docu of format arguments starts commonly with argument in column 0.
> %x however starts after comma inside a line:
> 
> "%s means print a string argument.  Actually, prints any object, with 
> ‘princ’.
> %d means print as signed number in decimal.
> %o means print as unsigned number in octal, %x as unsigned number in hex.
> "
> 
> Suggest to move docu of %x to column zero too.

Thanks, done.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 22 Jul 2018 11:24:05 GMT) Full text and rfc822 format available.
This bug report was last modified 7 years and 24 days ago.

Previous Next

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