GNU bug report logs - #52315
[PATH] Improve documentation of info-menu-star

Previous Next

Package: emacs;

Reported by: "Y. E." <yet <at> ego.team>

Date: Sun, 5 Dec 2021 19:18:02 UTC

Severity: minor

Tags: patch

Fixed in version 29.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 52315 in the body.
You can then email your comments to 52315 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#52315; Package emacs. (Sun, 05 Dec 2021 19:18:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to "Y. E." <yet <at> ego.team>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sun, 05 Dec 2021 19:18:02 GMT) Full text and rfc822 format available.

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

From: Y. E. <yet <at> ego.team>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATH] Improve documentation of info-menu-star
Date: Sun, 05 Dec 2021 21:17:44 +0200

[Message part 1 (text/plain, inline)]
Tags: patch

Hello,

I'm sending two alternate patches to improve the docstring of
info-menu-star. Either of them looks sufficiently fine to me. But one of
them might better suit Emacs' style.

The current docstring doesn't provide enough information on
info-menu-star, leaving open the question: why "every third `*' in an
Info menu" is so special?

Also, "every third" isn't a correct description, since only 1..9
numbers/items are used for navigation (and highlighted accordingly).


[0002-lisp-info.el-info-menu-star-Improve-documentation.patch (text/x-patch, attachment)]
[0001-lisp-info.el-info-menu-star-Improve-documentation.patch (text/patch, attachment)]
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52315; Package emacs. (Sun, 05 Dec 2021 21:07:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Y. E. <yet <at> ego.team>
Cc: 52315 <at> debbugs.gnu.org
Subject: Re: bug#52315: [PATH] Improve documentation of info-menu-star
Date: Sun, 05 Dec 2021 22:06:00 +0100

Y. E. <yet <at> ego.team> writes:

> I'm sending two alternate patches to improve the docstring of
> info-menu-star. Either of them looks sufficiently fine to me. But one of
> them might better suit Emacs' style.

Thanks; applied to Emacs 29.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
bug marked as fixed in version 29.1, send any further explanations to 52315 <at> debbugs.gnu.org and "Y. E." <yet <at> ego.team> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sun, 05 Dec 2021 21:07: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. (Mon, 03 Jan 2022 12:24:05 GMT) Full text and rfc822 format available.
This bug report was last modified 2 years and 114 days ago.

Previous Next

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