From: Y. E. via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 52315@debbugs.gnu.org
Subject: bug#52315: [PATH] Improve documentation of info-menu-star
Date: Sun, 05 Dec 2021 21:17:44 +0200 [thread overview]
Message-ID: <m2sfv62753.fsf@ego.team> (raw)
[-- 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
next reply other threads:[~2021-12-05 19:17 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-05 19:17 Y. E. via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2021-12-05 21:06 ` bug#52315: [PATH] Improve documentation of info-menu-star Lars Ingebrigtsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m2sfv62753.fsf@ego.team \
--to=bug-gnu-emacs@gnu.org \
--cc=52315@debbugs.gnu.org \
--cc=yet@ego.team \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).