bug#52315: [PATH] Improve documentation of info-menu-star

bug#52315: [PATH] Improve documentation of info-menu-star

[Y. E. via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 486 bytes --]

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).


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Alternate docstring update --]
[-- Type: text/x-patch, Size: 793 bytes --]

From f3d6948f6287411f1a151b69bc19fbfc7f5384e8 Mon Sep 17 00:00:00 2001
From: YugaEgo <yet@ego.team>
Date: Sun, 5 Dec 2021 19:59:29 +0200
Subject: [PATCH] * lisp/info.el (info-menu-star): Improve documentation

---
 lisp/info.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/info.el b/lisp/info.el
index 94537c2417..559460e8d2 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -115,7 +115,9 @@ info-menu-header
 (defface info-menu-star
   '((((class color)) :foreground "red1")
     (t :underline t))
-  "Face for every third `*' in an Info menu.")
+  "Face used to emphasize `*' in an Info menu.
+The face is assigned to the third, sixth, and ninth `*' for easier
+orientation.  See `Info-nth-menu-item'.")
 
 (defface info-xref
   '((t :inherit link))
-- 
2.34.1


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0001-lisp-info.el-info-menu-star-Improve-documentation.patch --]
[-- Type: text/patch, Size: 738 bytes --]

From a68f253743a6d927a226595c925d5d0018e15d06 Mon Sep 17 00:00:00 2001
From: YugaEgo <yet@ego.team>
Date: Sun, 5 Dec 2021 19:59:29 +0200
Subject: [PATCH] * lisp/info.el (info-menu-star): Improve documentation

---
 lisp/info.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/info.el b/lisp/info.el
index 94537c2417..bf30ff528f 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -115,7 +115,8 @@ info-menu-header
 (defface info-menu-star
   '((((class color)) :foreground "red1")
     (t :underline t))
-  "Face for every third `*' in an Info menu.")
+  "Face for 3rd, 6th, 9th `*' in an Info menu.
+This face eases orientation for `Info-nth-menu-item'.")
 
 (defface info-xref
   '((t :inherit link))
-- 
2.34.1

bug#52315: [PATH] Improve documentation of info-menu-star

[Lars Ingebrigtsen]

Y. E. <yet@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