From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Y. E. via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#52315: [PATH] Improve documentation of info-menu-star Date: Sun, 05 Dec 2021 21:17:44 +0200 Message-ID: Reply-To: "Y. E." Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1561"; mail-complaints-to="usenet@ciao.gmane.io" To: 52315@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Dec 05 20:18:33 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mtx1s-00006Y-FO for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Dec 2021 20:18:32 +0100 Original-Received: from localhost ([::1]:41998 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mtx1q-0000tI-Q2 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Dec 2021 14:18:30 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:51044) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mtx1O-0000s7-Sd for bug-gnu-emacs@gnu.org; Sun, 05 Dec 2021 14:18:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47930) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mtx1O-0006B7-L1 for bug-gnu-emacs@gnu.org; Sun, 05 Dec 2021 14:18:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mtx1O-0002Mg-EF for bug-gnu-emacs@gnu.org; Sun, 05 Dec 2021 14:18:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Y. E. Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 05 Dec 2021 19:18:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 52315 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.16387318799078 (code B ref -1); Sun, 05 Dec 2021 19:18:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 5 Dec 2021 19:17:59 +0000 Original-Received: from localhost ([127.0.0.1]:59476 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mtx1L-0002ML-5I for submit@debbugs.gnu.org; Sun, 05 Dec 2021 14:17:59 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:43588) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mtx1J-0002ME-Ps for submit@debbugs.gnu.org; Sun, 05 Dec 2021 14:17:58 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:51030) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mtx1I-0000nC-4G for bug-gnu-emacs@gnu.org; Sun, 05 Dec 2021 14:17:57 -0500 Original-Received: from out2.migadu.com ([188.165.223.204]:15348) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mtx1D-00052P-EX for bug-gnu-emacs@gnu.org; Sun, 05 Dec 2021 14:17:54 -0500 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ego.team; s=key1; t=1638731866; h=from:from:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type; bh=kS2al0RCRHmvaNSvygUwDwJmj8tWP+fhIDCEfHTcipw=; b=HFDDIobFMPGjFDf6PhUWtnFtpbylZlEDM4WRvG+Xcg7KWTRbyriXsxco4lq1j+eMr5sQaX uKR0gUKnP2myzPBKORWnuAwkNrTUlXhdAbr4YmwYzOmh6rijOR3wNkxQiNa6YQDD3ezpnP 77HsPdmSkySae6uK7S8hQ4XuXQ4PmFY= X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: ego.team Received-SPF: pass client-ip=188.165.223.204; envelope-from=yet@ego.team; helo=out2.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" X-ACL-Warn: , Y. E. Xref: news.gmane.io gmane.emacs.bugs:221638 Archived-At: --=-=-= Content-Type: text/plain 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). --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-lisp-info.el-info-menu-star-Improve-documentation.patch Content-Description: Alternate docstring update >From f3d6948f6287411f1a151b69bc19fbfc7f5384e8 Mon Sep 17 00:00:00 2001 From: YugaEgo 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 --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-lisp-info.el-info-menu-star-Improve-documentation.patch >From a68f253743a6d927a226595c925d5d0018e15d06 Mon Sep 17 00:00:00 2001 From: YugaEgo 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 --=-=-=--