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.

Full log


View this message in rfc822 format

From: Y. E. <yet <at> ego.team>
To: 52315 <at> debbugs.gnu.org
Subject: bug#52315: [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)]

This bug report was last modified 3 years and 166 days ago.

Previous Next


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