X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 22 Mar 2024 01:24:02 +0000
Resent-Message-ID: <handler.69935.B.17110706147584 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: report 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: 69935 <at> debbugs.gnu.org
X-Debbugs-Original-To: bug-gnu-emacs@HIDDEN
Received: via spool by submit <at> debbugs.gnu.org id=B.17110706147584
(code B ref -1); Fri, 22 Mar 2024 01:24:02 +0000
Received: (at submit) by debbugs.gnu.org; 22 Mar 2024 01:23:34 +0000
Received: from localhost ([127.0.0.1]:54070 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1rnTd7-0001yA-J5
for submit <at> debbugs.gnu.org; Thu, 21 Mar 2024 21:23:34 -0400
Received: from lists.gnu.org ([209.51.188.17]:35954)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <monnier@HIDDEN>) id 1rnTd4-0001xp-Ff
for submit <at> debbugs.gnu.org; Thu, 21 Mar 2024 21:23:31 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10])
by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <monnier@HIDDEN>)
id 1rnTcP-0001N0-Q9
for bug-gnu-emacs@HIDDEN; Thu, 21 Mar 2024 21:22:49 -0400
Received: from mailscanner.iro.umontreal.ca ([132.204.25.50])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <monnier@HIDDEN>)
id 1rnTcN-0007hO-Fw
for bug-gnu-emacs@HIDDEN; Thu, 21 Mar 2024 21:22:49 -0400
Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1])
by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id E899980577;
Thu, 21 Mar 2024 21:22:44 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca;
s=mail; t=1711070560;
bh=YWc6DY91MPgSTcDauewa3rA3WMdNQpNiUq18gqQAIcA=;
h=From:To:Subject:Date:From;
b=pZxK0Cd9oS2LWmQasQPXTJHwLCdmf1svfKb6FL0lmPpd8lJsKPhsnqzhmMbcIv8JB
NcwA5AXPYeMUQ4EADRtgjUAV+zpQOT40qRKmN0EEykNmrKDTph4cyGJ091jVKHMJiD
2bC7OyI7/4P7SysNfW2pGhdb2QnhfT77fGcIZwPxKprzYVUC8v/eBnEkSFoHC5SIZa
G1P2iLe1Y6l11969ZObdO5nFZajwZsxv4gizin/h276Zc3Pt3MvfV4WNGVHEgYDPrK
QD8eNFI1tPmX6N2Ymgga2jIIhi0FwpTGMgSLfv8w/GTRQ2hpbHfgWOEKPW20mgHIVr
BqGdSXUY5BRcA==
Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1])
by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id A7F8680A95;
Thu, 21 Mar 2024 21:22:40 -0400 (EDT)
Received: from pastel (unknown [104.247.238.200])
by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 8ADC4120828;
Thu, 21 Mar 2024 21:22:40 -0400 (EDT)
From: Stefan Monnier <monnier@HIDDEN>
Message-ID: <jwvedc39ine.fsf-monnier+@gnu.org>
Date: Thu, 21 Mar 2024 21:22:39 -0400
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
X-SPAM-INFO: Spam detection results: 0
ALL_TRUSTED -1 Passed through trusted hosts only via SMTP
AWL -0.225 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DKIM_SIGNED 0.1 Message has a DKIM or DK signature,
not necessarily valid
DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature
DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's
domain
DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from
domain
X-SPAM-LEVEL:
Received-SPF: pass client-ip=132.204.25.50;
envelope-from=monnier@HIDDEN; helo=mailscanner.iro.umontreal.ca
X-Spam_score_int: -42
X-Spam_score: -4.3
X-Spam_bar: ----
X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3,
SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -1.3 (-)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.3 (--)
--=-=-=
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Tags: patch
The patch below changes the first line of `C-h f` from something like:
car is a built-in function in =E2=80=98C source code=E2=80=99.
to
car is a primitive-function in =E2=80=98C source code=E2=80=99.
i.e. print the actual type rather than an English description.
The type is buttonized so users can click on it to see a description of
the type (and its super/subtypes).
Beside exposing those types (and their related information), another
advantage is that it simplifies the code since we don't need to
enumerate all the different kinds of functions we may have (well, we
still do for those "function-like objects" which don't have a dedicated
type such as macros, keymaps, aliases, keyboard macros, yadda yadda, but
a single case covers all of special forms, primitive functions,
byte-code functions, module functions, and native-compiled functions).
Any comment/objection?
Stefan
In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
3.24.38, cairo version 1.16.0) of 2024-02-23 built on pastel
Repository revision: 831e094a09f70a15e4b4b83c5158dbeb8d9daede
Repository branch: work
Windowing system distributor 'The X.Org Foundation', version 11.0.12101007
System Description: Debian GNU/Linux 12 (bookworm)
Configured using:
'configure -C --enable-checking --enable-check-lisp-object-type --with-mod=
ules --with-cairo --with-tiff=3Difavailable
'CFLAGS=3D-Wall -g3 -Og -Wno-pointer-sign' --without-native-compilation
PKG_CONFIG_PATH=3D/home/monnier/lib/pkgconfig'
--=-=-=
Content-Type: text/patch
Content-Disposition: attachment;
filename=0001-help-fns-function-description-header-Print-functions.patch
From 8169ad959bfca252fa4ef824f7ee10005f922431 Mon Sep 17 00:00:00 2001
From: Stefan Monnier <monnier@HIDDEN>
Date: Thu, 21 Mar 2024 21:08:58 -0400
Subject: [PATCH] (help-fns-function-description-header): Print functions' type
Instead of choosing English words to describe the kind of function,
use the actual type of the function object (from `cl-type-of`)
directly, and make it a button to display info about that type.
* lisp/help-fns.el (help-fns-function-description-header): Use the
function's type name in the description instead of "prose".
Use `insert` instead of `princ`, so as to preserve the text-properties
of the button.
* lisp/emacs-lisp/cl-extra.el (cl-help-type): Move to `help-mode.el`
and rename to `help-type`.
(cl--describe-class): Adjust accordingly.
* lisp/help-mode.el (help-type): New type, moved and renamed from
`cl-extra.el`.
---
lisp/emacs-lisp/cl-extra.el | 11 +++--------
lisp/help-fns.el | 31 ++++++++++++++-----------------
lisp/help-mode.el | 5 +++++
3 files changed, 22 insertions(+), 25 deletions(-)
diff --git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el
index d43c21d3eb9..437dea2d6a9 100644
--- a/lisp/emacs-lisp/cl-extra.el
+++ b/lisp/emacs-lisp/cl-extra.el
@@ -720,11 +720,6 @@ cl--typedef-regexp
(add-to-list 'find-function-regexp-alist
'(define-type . cl--typedef-regexp)))
-(define-button-type 'cl-help-type
- :supertype 'help-function-def
- 'help-function #'cl-describe-type
- 'help-echo (purecopy "mouse-2, RET: describe this type"))
-
(define-button-type 'cl-type-definition
:supertype 'help-function-def
'help-echo (purecopy "mouse-2, RET: find type definition"))
@@ -777,7 +772,7 @@ cl--describe-class
(insert (symbol-name type)
(substitute-command-keys " is a type (of kind `"))
(help-insert-xref-button (symbol-name metatype)
- 'cl-help-type metatype)
+ 'help-type metatype)
(insert (substitute-command-keys "')"))
(when location
(insert (substitute-command-keys " in `"))
@@ -796,7 +791,7 @@ cl--describe-class
(setq cur (cl--class-name cur))
(insert (substitute-quotes "`"))
(help-insert-xref-button (symbol-name cur)
- 'cl-help-type cur)
+ 'help-type cur)
(insert (substitute-command-keys (if pl "', " "'"))))
(insert ".\n")))
@@ -808,7 +803,7 @@ cl--describe-class
(while (setq cur (pop ch))
(insert (substitute-quotes "`"))
(help-insert-xref-button (symbol-name cur)
- 'cl-help-type cur)
+ 'help-type cur)
(insert (substitute-command-keys (if ch "', " "'"))))
(insert ".\n")))
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 422f6e9dddf..79a39c3d639 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -1061,10 +1061,10 @@ help-fns-function-description-header
(concat
"an autoloaded " (if (commandp def)
"interactive "))
- (if (commandp def) "an interactive " "a "))))
-
- ;; Print what kind of function-like object FUNCTION is.
- (princ (cond ((or (stringp def) (vectorp def))
+ (if (commandp def) "an interactive " "a ")))
+ ;; Print what kind of function-like object FUNCTION is.
+ (description
+ (cond ((or (stringp def) (vectorp def))
"a keyboard macro")
((and (symbolp function)
(get function 'reader-construct))
@@ -1073,12 +1073,6 @@ help-fns-function-description-header
;; aliases before functions.
(aliased
(format-message "an alias for `%s'" real-def))
- ((subr-native-elisp-p def)
- (concat beg "native-compiled Lisp function"))
- ((subrp def)
- (concat beg (if (eq 'unevalled (cdr (subr-arity def)))
- "special form"
- "built-in function")))
((autoloadp def)
(format "an autoloaded %s"
(cond
@@ -1092,12 +1086,13 @@ help-fns-function-description-header
;; need to check macros before functions.
(macrop function))
(concat beg "Lisp macro"))
- ((byte-code-function-p def)
- (concat beg "byte-compiled Lisp function"))
- ((module-function-p def)
- (concat beg "module function"))
- ((memq (car-safe def) '(lambda closure))
- (concat beg "Lisp function"))
+ ((atom def)
+ (let ((type (or (oclosure-type def) (cl-type-of def))))
+ (concat beg (format "%s"
+ (make-text-button
+ (symbol-name type) nil
+ 'type 'help-type
+ 'help-args (list type))))))
((keymapp def)
(let ((is-full nil)
(elts (cdr-safe def)))
@@ -1107,7 +1102,9 @@ help-fns-function-description-header
elts nil))
(setq elts (cdr-safe elts)))
(concat beg (if is-full "keymap" "sparse keymap"))))
- (t "")))
+ (t ""))))
+ (with-current-buffer standard-output
+ (insert description))
(if (and aliased (not (fboundp real-def)))
(princ ",\nwhich is not defined.")
diff --git a/lisp/help-mode.el b/lisp/help-mode.el
index dd78342ace7..48433d899ab 100644
--- a/lisp/help-mode.el
+++ b/lisp/help-mode.el
@@ -177,6 +177,11 @@ 'help-variable
'help-function 'describe-variable
'help-echo (purecopy "mouse-2, RET: describe this variable"))
+(define-button-type 'help-type
+ :supertype 'help-xref
+ 'help-function #'cl-describe-type
+ 'help-echo (purecopy "mouse-2, RET: describe this type"))
+
(define-button-type 'help-face
:supertype 'help-xref
'help-function 'describe-face
--
2.43.0
--=-=-=--
Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) Content-Type: text/plain; charset=utf-8 X-Loop: help-debbugs@HIDDEN From: help-debbugs@HIDDEN (GNU bug Tracking System) To: Stefan Monnier <monnier@HIDDEN> Subject: bug#69935: Acknowledgement ([PATCH] (help-fns-function-description-header): Print functions' type) Message-ID: <handler.69935.B.17110706147584.ack <at> debbugs.gnu.org> References: <jwvedc39ine.fsf-monnier+@gnu.org> X-Gnu-PR-Message: ack 69935 X-Gnu-PR-Package: emacs X-Gnu-PR-Keywords: patch Reply-To: 69935 <at> debbugs.gnu.org Date: Fri, 22 Mar 2024 01:24:02 +0000 Thank you for filing a new bug report with debbugs.gnu.org. This is an automatically generated reply to let you know your message has been received. Your message is being forwarded to the package maintainers and other interested parties for their attention; they will reply in due course. Your message has been sent to the package maintainer(s): bug-gnu-emacs@HIDDEN If you wish to submit further information on this problem, please send it to 69935 <at> debbugs.gnu.org. Please do not send mail to help-debbugs@HIDDEN unless you wish to report a problem with the Bug-tracking system. --=20 69935: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D69935 GNU Bug Tracking System Contact help-debbugs@HIDDEN with problems
X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Eli Zaretskii <eliz@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 22 Mar 2024 08:14:03 +0000
Resent-Message-ID: <handler.69935.B69935.171109520527315 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: Stefan Monnier <monnier@HIDDEN>
Cc: 69935 <at> debbugs.gnu.org
Received: via spool by 69935-submit <at> debbugs.gnu.org id=B69935.171109520527315
(code B ref 69935); Fri, 22 Mar 2024 08:14:03 +0000
Received: (at 69935) by debbugs.gnu.org; 22 Mar 2024 08:13:25 +0000
Received: from localhost ([127.0.0.1]:58972 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1rna1k-00076L-5u
for submit <at> debbugs.gnu.org; Fri, 22 Mar 2024 04:13:24 -0400
Received: from eggs.gnu.org ([209.51.188.92]:58454)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <eliz@HIDDEN>) id 1rna1i-00075v-6a
for 69935 <at> debbugs.gnu.org; Fri, 22 Mar 2024 04:13:23 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <eliz@HIDDEN>)
id 1rnZI8-0007xX-7P; Fri, 22 Mar 2024 03:26:16 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From:
Date; bh=vVMIx3uTUyfAHhwXK/QKJOy9GIwf0BNr/G1uwYwTAU4=; b=avAFnty/GbkwxdlETpYD
ysAFf0s6xnHvEh7qffQgGWFI7/ILO+/m1cl1t70HFPkNXuaibvYs3PLhVmGLyzsg1w57iTqgfXq2Q
k6CzspvPy+DTPeNbARRfodf0ecI5rb6GA9wlwPmL6iEF5fn04UyOjtSzg3CM5gku726xh3t5VZftK
sI+YEHp7h8qwy0YAPKc/oB70XuYmzQXT9PxDsyL/curwbALKgatkMaVvkD3agkmBDNSUtLYRDBvI8
dOfrQlI8h/QL/95GYvH1fH5TOEb14ViPDT4O/BL8pq02dCQYGLD+uJsTVQM7uD2QVL+y00on74vek
gUs7igAZ3O5qJA==;
Date: Fri, 22 Mar 2024 09:25:58 +0200
Message-Id: <86edc220e1.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
In-Reply-To: <jwvedc39ine.fsf-monnier+@gnu.org> (bug-gnu-emacs@HIDDEN)
References: <jwvedc39ine.fsf-monnier+@gnu.org>
MIME-version: 1.0
Content-type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)
> Date: Thu, 21 Mar 2024 21:22:39 -0400
> From: Stefan Monnier via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@HIDDEN>
>
> The patch below changes the first line of `C-h f` from something like:
>
> car is a built-in function in ‘C source code’.
>
> to
>
> car is a primitive-function in ‘C source code’.
>
> i.e. print the actual type rather than an English description.
> The type is buttonized so users can click on it to see a description of
> the type (and its super/subtypes).
>
> Beside exposing those types (and their related information), another
> advantage is that it simplifies the code since we don't need to
> enumerate all the different kinds of functions we may have (well, we
> still do for those "function-like objects" which don't have a dedicated
> type such as macros, keymaps, aliases, keyboard macros, yadda yadda, but
> a single case covers all of special forms, primitive functions,
> byte-code functions, module functions, and native-compiled functions).
>
> Any comment/objection?
No objections, but IMO this should be in NEWS, and the button and
its purpose should be described in the user manual (where we document
"C-h f").
Thanks.
X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Andrea Corallo <acorallo@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 22 Mar 2024 16:25:02 +0000
Resent-Message-ID: <handler.69935.B69935.171112468830365 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: 69935 <at> debbugs.gnu.org
Cc: Stefan Monnier <monnier@HIDDEN>
Received: via spool by 69935-submit <at> debbugs.gnu.org id=B69935.171112468830365
(code B ref 69935); Fri, 22 Mar 2024 16:25:02 +0000
Received: (at 69935) by debbugs.gnu.org; 22 Mar 2024 16:24:48 +0000
Received: from localhost ([127.0.0.1]:34486 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1rnhhI-0007th-65
for submit <at> debbugs.gnu.org; Fri, 22 Mar 2024 12:24:48 -0400
Received: from eggs.gnu.org ([209.51.188.92]:59860)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <acorallo@HIDDEN>) id 1rnhhF-0007tT-Oh
for 69935 <at> debbugs.gnu.org; Fri, 22 Mar 2024 12:24:47 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <acorallo@HIDDEN>)
id 1rngzu-00011B-93; Fri, 22 Mar 2024 11:39:58 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To:
From; bh=CBqz1X/Kl2rG/muNTcEMAskAmTWoMCf9Lt/WtRyhSPk=; b=gvcEDMhLwrS0zuJM1YUW
f9KjEvi9LNJKpwOzIs9JOEpFfEIhslsksBvvqn5bdDMPLnIAz5OOlsD8QrPgrd3ao6QLEy4PMt9xP
Jc66lLz4GubWo83j6byjVfXKwV9i7otBPQ/yk0TlqIJ5WowUwZKI2w80OppYfz3HZ6nQ4q04/Pbu1
uRK5kopqOR5MVTzGMCcKo7bO+amtw0rj977tsKp9Ay4Z2ECKvTruiksF8n0LPcHvojVs8t8ROTJnK
qZclNga8SZ8wzXYBnBE/+kDl6CtiFLEwQokXc66Uml6P7tKXkdPUufVuN04hZ3xBGylIJoTVq035G
HFoGMIZJ8M3TCg==;
Received: from acorallo by fencepost.gnu.org with local (Exim 4.90_1)
(envelope-from <acorallo@HIDDEN>)
id 1rngzt-0004Yx-AH; Fri, 22 Mar 2024 11:39:57 -0400
From: Andrea Corallo <acorallo@HIDDEN>
In-Reply-To: <jwvedc39ine.fsf-monnier+@gnu.org> (Stefan Monnier via's message
of "Thu, 21 Mar 2024 21:22:39 -0400")
References: <jwvedc39ine.fsf-monnier+@gnu.org>
Date: Fri, 22 Mar 2024 11:39:57 -0400
Message-ID: <yp1frwis2b6.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)
Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs@HIDDEN> writes:
> Tags: patch
>
> The patch below changes the first line of `C-h f` from something like:
>
> car is a built-in function in =E2=80=98C source code=E2=80=99.
>
> to
>
> car is a primitive-function in =E2=80=98C source code=E2=80=99.
>
> i.e. print the actual type rather than an English description.
> The type is buttonized so users can click on it to see a description of
> the type (and its super/subtypes).
>
> Beside exposing those types (and their related information), another
> advantage is that it simplifies the code since we don't need to
> enumerate all the different kinds of functions we may have (well, we
> still do for those "function-like objects" which don't have a dedicated
> type such as macros, keymaps, aliases, keyboard macros, yadda yadda, but
> a single case covers all of special forms, primitive functions,
> byte-code functions, module functions, and native-compiled functions).
>
> Any comment/objection?
Hi Stefan,
I like it thanks! I think we might want to highlight the
inferred/declared argument/ret types as well WDYT?
I might implement something along this line once your patch is.
Thanks
Andrea
X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 22 Mar 2024 21:16:02 +0000
Resent-Message-ID: <handler.69935.B69935.17111421324947 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: Eli Zaretskii <eliz@HIDDEN>
Cc: 69935 <at> debbugs.gnu.org
Received: via spool by 69935-submit <at> debbugs.gnu.org id=B69935.17111421324947
(code B ref 69935); Fri, 22 Mar 2024 21:16:02 +0000
Received: (at 69935) by debbugs.gnu.org; 22 Mar 2024 21:15:32 +0000
Received: from localhost ([127.0.0.1]:49735 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1rnmEe-0001Hj-AU
for submit <at> debbugs.gnu.org; Fri, 22 Mar 2024 17:15:32 -0400
Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:2524)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <monnier@HIDDEN>) id 1rnmEc-0001HN-Nt
for 69935 <at> debbugs.gnu.org; Fri, 22 Mar 2024 17:15:31 -0400
Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1])
by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 22469812F7;
Fri, 22 Mar 2024 17:14:43 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca;
s=mail; t=1711142081;
bh=Agm6YXYttfi9HKo1axN2iDk5f+pZqZbE5AIOXytsneo=;
h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
b=Kw3v/ggPgzpxrLwWUSo8kvJQCensCs2E2JP9sVZTAI6l21CtcyyvcnNso+aghcQxC
9JPkhdrM6BJ8QWiFErGzh1IGtz1g3cSX8bNO1CkKn/vSPPiizX1a24SBwsYHpXtHcb
OWriSITt4PoiZ0dXk8UjZA23l7GtXdosELL1YpD5HskP58rQocUL9OsWV712cj30kV
4sFFW9OlsLZU+RA69RXz8YQpvLS/W2jxlhYqCohi3wRhDImKCdhA5dKLvDjFeWGTgz
RxMsUaOn1uMFVUA7sdp+aw8F0NdBDNreJivEPWOpH7fQ6nDSGatYhkNjMNLmeaXdF4
zftSdHT0AMepQ==
Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1])
by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id AFA14800D0;
Fri, 22 Mar 2024 17:14:41 -0400 (EDT)
Received: from pastel (unknown [104.247.238.200])
by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 891F6120708;
Fri, 22 Mar 2024 17:14:41 -0400 (EDT)
From: Stefan Monnier <monnier@HIDDEN>
In-Reply-To: <86edc220e1.fsf@HIDDEN> (Eli Zaretskii's message of "Fri, 22 Mar
2024 09:25:58 +0200")
Message-ID: <jwvle6a7zdy.fsf-monnier+emacs@HIDDEN>
References: <jwvedc39ine.fsf-monnier+@gnu.org> <86edc220e1.fsf@HIDDEN>
Date: Fri, 22 Mar 2024 17:14:40 -0400
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain
X-SPAM-INFO: Spam detection results: 0
ALL_TRUSTED -1 Passed through trusted hosts only via SMTP
AWL -0.215 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DKIM_SIGNED 0.1 Message has a DKIM or DK signature,
not necessarily valid
DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature
DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's
domain
DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from
domain
X-SPAM-LEVEL:
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)
> No objections, but IMO this should be in NEWS,
Good point, just added, thanks.
> and the button and its purpose should be described in the user manual
> (where we document "C-h f").
Hmm.. not sure where/how to add it there. The current text doesn't
discuss/mention the other buttons (like the button to jump to the
source) and auxiliary information, so I'm not sure what you
were expecting. My proposal would be something like the text below.
Is that the kind of thing you were thinking about?
[ Side note: I already pushed my proposed patch (without doc changes,
obviously) accidentally when I pushed another change.
Sorry 'bout that. ]
Stefan
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi
index 05457a3f34f..a6136ad6554 100644
--- a/doc/emacs/help.texi
+++ b/doc/emacs/help.texi
@@ -310,6 +310,12 @@ Name Help
@kbd{C-h f} command if you don't really want to view the
documentation.
+ The function's documentation displayed by @code{describe-function}
+includes more than just the documentation string and the signature of
+the function. It also shows auxiliary information such as its type,
+the file where it was defined, whether it has been declared obsolete,
+etc...
+
@vindex help-enable-symbol-autoload
If you request help for an autoloaded function whose @code{autoload}
form (@pxref{Autoload,,, elisp, The Emacs Lisp Reference Manual})
X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Eli Zaretskii <eliz@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 23 Mar 2024 06:48:02 +0000
Resent-Message-ID: <handler.69935.B69935.17111764332451 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: Stefan Monnier <monnier@HIDDEN>
Cc: 69935 <at> debbugs.gnu.org
Received: via spool by 69935-submit <at> debbugs.gnu.org id=B69935.17111764332451
(code B ref 69935); Sat, 23 Mar 2024 06:48:02 +0000
Received: (at 69935) by debbugs.gnu.org; 23 Mar 2024 06:47:13 +0000
Received: from localhost ([127.0.0.1]:57759 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1rnv9s-0000dS-LU
for submit <at> debbugs.gnu.org; Sat, 23 Mar 2024 02:47:13 -0400
Received: from eggs.gnu.org ([209.51.188.92]:47152)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <eliz@HIDDEN>) id 1rnv9q-0000dA-65
for 69935 <at> debbugs.gnu.org; Sat, 23 Mar 2024 02:47:11 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
(Exim 4.90_1) (envelope-from <eliz@HIDDEN>)
id 1rnv6x-00041S-IF; Sat, 23 Mar 2024 02:44:12 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date:
mime-version; bh=wNeJ/zVapySQfZ9dtdK+lnCWOguCp2t6mw65XXbXD5A=; b=B+4EipY3TlqY
bRCmY6NU6UMLeV4fngpBX+Lins/whlhUXozFDXE2ve9QZHJJgUTDdHgsEZq1jRY3DS6jepfmeWr6f
xYtITdDfW41V2JOlBkKv82CFmWVC5sBG3LbS5/NTOGcgNS+n4kQX1TUZWgZDiumir+mWn86s2uex3
4QyMO3Nw6NDi4C4JvHFR1r06SjrgNTqmksz2QqP+2DZkqG3OjuaqXCfIvkXc3KcgdSY8UTIRmFMAR
pJhI2PFvbh6wBpbD3OPl9jaJPFOns2tDoct4YwR8+T1SioU7E395LqvkoBsvk1bVzE7NeRK6VuuR6
ld4XOyjx1cL3AhpnygvbmA==;
Date: Sat, 23 Mar 2024 08:44:09 +0200
Message-Id: <86v85dzbuu.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
In-Reply-To: <jwvle6a7zdy.fsf-monnier+emacs@HIDDEN> (message from Stefan
Monnier on Fri, 22 Mar 2024 17:14:40 -0400)
References: <jwvedc39ine.fsf-monnier+@gnu.org> <86edc220e1.fsf@HIDDEN>
<jwvle6a7zdy.fsf-monnier+emacs@HIDDEN>
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)
> From: Stefan Monnier <monnier@HIDDEN>
> Cc: 69935 <at> debbugs.gnu.org
> Date: Fri, 22 Mar 2024 17:14:40 -0400
>
> > and the button and its purpose should be described in the user manual
> > (where we document "C-h f").
>
> Hmm.. not sure where/how to add it there. The current text doesn't
> discuss/mention the other buttons (like the button to jump to the
> source) and auxiliary information, so I'm not sure what you
> were expecting. My proposal would be something like the text below.
> Is that the kind of thing you were thinking about?
Yes, except that I would suggest to mention that some of the auxiliary
information is reachable by clicking or typing RET on hyperlink-style
emphasized parts of the text displayed in the *Help* buffer.
X-Loop: help-debbugs@HIDDEN
Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type
Resent-From: Stefan Kangas <stefankangas@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 01 Mar 2025 03:08:01 +0000
Resent-Message-ID: <handler.69935.B69935.174079844113767 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 69935
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: patch
To: Eli Zaretskii <eliz@HIDDEN>
Cc: 69935 <at> debbugs.gnu.org, Stefan Monnier <monnier@HIDDEN>
Received: via spool by 69935-submit <at> debbugs.gnu.org id=B69935.174079844113767
(code B ref 69935); Sat, 01 Mar 2025 03:08:01 +0000
Received: (at 69935) by debbugs.gnu.org; 1 Mar 2025 03:07:21 +0000
Received: from localhost ([127.0.0.1]:56904 helo=debbugs.gnu.org)
by debbugs.gnu.org with esmtp (Exim 4.84_2)
(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
id 1toDCD-0003Zy-7T
for submit <at> debbugs.gnu.org; Fri, 28 Feb 2025 22:07:21 -0500
Received: from mail-ed1-x529.google.com ([2a00:1450:4864:20::529]:41997)
by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
(Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
id 1toDCB-0003ZN-Ey
for 69935 <at> debbugs.gnu.org; Fri, 28 Feb 2025 22:07:20 -0500
Received: by mail-ed1-x529.google.com with SMTP id
4fb4d7f45d1cf-5dccaaca646so5268409a12.0
for <69935 <at> debbugs.gnu.org>; Fri, 28 Feb 2025 19:07:19 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=gmail.com; s=20230601; t=1740798433; x=1741403233; darn=debbugs.gnu.org;
h=cc:to:subject:message-id:date:mime-version:references:in-reply-to
:from:from:to:cc:subject:date:message-id:reply-to;
bh=96YfL01+ORQCLXJF+x/pcozFGMeuUq4PaD4xYsOOzy4=;
b=Cu1aD/06GY3OUGo3oRDcBeC9pt/S3QB2f/Ly0nY7fM2jWzfIiyeSJvze8ABHWGhI+u
HWmZRwM3DVxTu79jscrX9fWh8sI2HjtIziZvqXb9B+rsBAug9D0kEnTJdF89BDm0qgeR
IPxqpS79jN7WFG1VJ8TLZv6aClf8N34+NlXMNO4A+ZDi/+ymlO6oAHVLZigdvoZS4epM
2xSB/X6jtBrl69ZV2Vezyb/BzC+sSisellcOqnG5MVlN2YrYYjsenuJiwAZO2fYx/Tb8
xHOjaP7ws134JP8VPbP4jYHo/HtnBkc/cYURxu/MdoSb2pGts756EvXMeHeVV8GrHX+l
KOPA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1740798433; x=1741403233;
h=cc:to:subject:message-id:date:mime-version:references:in-reply-to
:from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to;
bh=96YfL01+ORQCLXJF+x/pcozFGMeuUq4PaD4xYsOOzy4=;
b=H+6f0Jxl+CixhrgZue1zyYD77V0qfIFpAsI4IlQG/ukee976JhOqZnyyyhBsZ1t7Qp
fpiJfm1MJRAO2WZm3e1evAeVmbQW6ufBHHcL9wn9UlZXbmuU0/2gMVEBM82uUkyARY8q
kkIL7eb5y94uShX24EpxvQmn4mdr2f5Nmpg2bcK+LwE18p6p7rhua/35WUQFGrOzIQV+
u0/zzKU975mnGQyHiU0svAvVQbx7K7oc3/L8/E1InczmFGk33t/Etywd1oNkQmofDwwv
TPkmUJgEDnW527nLq/6DfWVbYEY28MlF5YBXNZaTkPP2sV24IeA/x8WbpJqNfXaWbmhJ
pJTw==
X-Forwarded-Encrypted: i=1;
AJvYcCVXC/fG3U6yuGqdgtVxqLtFY1mij/XdUcjeMlge51XJzIWjgGCGtpFN1XZIVimCvF1P+VO9xQ==@debbugs.gnu.org
X-Gm-Message-State: AOJu0YwpFSScIVyFwnk4HNUAwjpMCyzZ81a3zsAzyjNjLQRWNQy7/u0s
Ge8YKOxQEQ3Wv/KtnvzWDhRcvpYNxznmRcTkGoUz8drdkt9Mh9rFUWu5kPu80oJTGThdDyp5vdm
o0EBMqEnKaaf07udGJPsUiC40oNsuBDuePm0=
X-Gm-Gg: ASbGncv6xDJpH0YUTMmIzyCECL5chnoiBxBPNOhOzTwKklySaqmEaXkI3J1xLz+Tw4/
VW23HJpvWhrVMFCB9l6fry15Td9KfgBkWWljt/ZP+SYWyv/+5mM/SoPmKhnqf7RL4XdyTNW5WJy
XkTiKbxg5Kn0quHyEDL4StgfZz06M=
X-Google-Smtp-Source: AGHT+IE65Do1cTJt0TEUSqjlj9RgRZKXPXlYwalwq3xRx1+4ST8jO89dZItd99KhqWgA25gyO/5o4+gKjW5v/neTP+s=
X-Received: by 2002:a05:6402:3587:b0:5e4:a23c:cf60 with SMTP id
4fb4d7f45d1cf-5e4d52f7ef4mr5501486a12.15.1740798432819; Fri, 28 Feb 2025
19:07:12 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
HTTPREST; Fri, 28 Feb 2025 19:07:12 -0800
From: Stefan Kangas <stefankangas@HIDDEN>
In-Reply-To: <86v85dzbuu.fsf@HIDDEN>
References: <jwvedc39ine.fsf-monnier+@gnu.org> <86edc220e1.fsf@HIDDEN>
<jwvle6a7zdy.fsf-monnier+emacs@HIDDEN> <86v85dzbuu.fsf@HIDDEN>
MIME-Version: 1.0
Date: Fri, 28 Feb 2025 19:07:12 -0800
X-Gm-Features: AQ5f1JplO0UZCaN0YB-oLg16Ml18UQwAnaKkD9Zx1mwz8rF2rkUDR10_uGFSQts
Message-ID: <CADwFkmmppXkv-=wHRUrV5SNHzrGqsdvnGq-qeQdeuRq0GqvN5A@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>,
<mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)
Eli Zaretskii <eliz@HIDDEN> writes:
>> From: Stefan Monnier <monnier@HIDDEN>
>> Cc: 69935 <at> debbugs.gnu.org
>> Date: Fri, 22 Mar 2024 17:14:40 -0400
>>
>> > and the button and its purpose should be described in the user manual
>> > (where we document "C-h f").
>>
>> Hmm.. not sure where/how to add it there. The current text doesn't
>> discuss/mention the other buttons (like the button to jump to the
>> source) and auxiliary information, so I'm not sure what you
>> were expecting. My proposal would be something like the text below.
>> Is that the kind of thing you were thinking about?
>
> Yes, except that I would suggest to mention that some of the auxiliary
> information is reachable by clicking or typing RET on hyperlink-style
> emphasized parts of the text displayed in the *Help* buffer.
Stefan, did you install the documentation changes here?
I see that the patch itself is installed already. Thanks.
Received: (at control) by debbugs.gnu.org; 1 Mar 2025 03:07:33 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Fri Feb 28 22:07:33 2025 Received: from localhost ([127.0.0.1]:56910 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1toDCO-0003bQ-ME for submit <at> debbugs.gnu.org; Fri, 28 Feb 2025 22:07:33 -0500 Received: from mail-ed1-x534.google.com ([2a00:1450:4864:20::534]:44125) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>) id 1toDCH-0003Zn-AU for control <at> debbugs.gnu.org; Fri, 28 Feb 2025 22:07:25 -0500 Received: by mail-ed1-x534.google.com with SMTP id 4fb4d7f45d1cf-5e095d47a25so4703950a12.0 for <control <at> debbugs.gnu.org>; Fri, 28 Feb 2025 19:07:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740798439; x=1741403239; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:from:from:to:cc:subject :date:message-id:reply-to; bh=az9JI+aNB7cXBs9EBrzenHsYJ9HKMqG7i7LrPOSuoRY=; b=S1Ma8S90cnno/m1oygR+95JCjrNlnZGieYlsrQtzouu/IixXINFXlGqI/V5rMFInrg ZrxbfCF277TiyXpO1x+QovvrsXlItlqtTHJvJjJsNDYryd9TyJdXBfFlkZ6oZ+mZt3/q geG5ggc34WZxsjtTox6hd5XifeVKcBJwZE6gppRKivmk8ui9N/Fjck7fb5E++DY4wDVZ 1iTzxVItQjO/VYT7g6xPetL+GTyEKht+Dt2iQdz+TQ1/v8ScvVKRtXw/sHADiKuByT+a 5977dPe05LerI6zC5CBkvX9Ln4EzbzngoeqG8zP7O+U/28a6sRpuCOzaCVvYyopFFOLG X2LA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740798439; x=1741403239; h=to:subject:message-id:date:mime-version:from:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=az9JI+aNB7cXBs9EBrzenHsYJ9HKMqG7i7LrPOSuoRY=; b=QdGylgMj1ibPnw4/KlRJFN2ERl96/3b256gpXAnLPs+rMpkbwBHxuQu/bFo/ZBsSQJ 6VCgA5mz/KHjeAQDJN7EQiMs1HXMR+/Zk90zEQjMYbWjf/aWCz0DZDX4uRrzq8bZvjvl 8FlANt5AHIiiv5UcKx9Hyb7BLw0yd6avhdPkTKcYrZQd4Stc/ZRK5APMiK+qxWkQanZ1 OosKv0Pc9Y5GJIlTJX+lzQiIb/amuvdgWEepY2NhOjmqk8eeHUTuoTDN0YHcxZ8PGpDH 4u71pjVj6BLVKkBPns59zgZU1RswZCOohgFo1fe4YB0fP4ZcDJuYYVskL+4YqVceiXs+ V8vg== X-Gm-Message-State: AOJu0YzBjx6vvkMsoU1/xmGParVz40ZlceWdP46mb1ybsBgJ5dRnuCUh XrvVSYgb/cSkGSB5sByjOcjZS4Bug0Ed7CWKRojWQMDb5jsJUfgwV3uAdOUgS94I31M/DCFdp6R 0GH2W1nUczkBHQs8GyzoGMC/QpbMkWLANLsQ= X-Gm-Gg: ASbGnctgx+CncoaEEkQPYRGtd/L4IWrc/wF4zkPC60qcwLGjeLzT3d8maSH1vI5YePt zE6YiQ4CTnUv8MTNMBkgIn6VgKXwzTIjWwW9Ke6hMYHKd6TSAY0ESdfWMrSySiQk3yARzEBvnPK 3Gjr2UZ/ILRTotgs++GDjZiiR1DPk= X-Google-Smtp-Source: AGHT+IHnNt/jV/Eq11RUgdwcNbPnZCT5zB76J7OUzXUNcJ/p/nL36BFSlrXPTdf/TltI0vCAydoTTJMogUWnCJ36dNk= X-Received: by 2002:a05:6402:847:b0:5e4:cd5c:50f6 with SMTP id 4fb4d7f45d1cf-5e4d6afaf1dmr5102574a12.18.1740798439196; Fri, 28 Feb 2025 19:07:19 -0800 (PST) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Fri, 28 Feb 2025 19:07:18 -0800 From: Stefan Kangas <stefankangas@HIDDEN> MIME-Version: 1.0 Date: Fri, 28 Feb 2025 19:07:18 -0800 X-Gm-Features: AQ5f1Jrkg1S9_NKbr854DnWiF1WGt-H5-6vwsGID265J8cfJBcaI6xYGroIdhRU Message-ID: <CADwFkmk4=+T7iPE4S2RnFKbA9sT-27WC6kmbwOKWFYz5efJtww@HIDDEN> Subject: control message for bug #69935 To: control <at> debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> X-Spam-Score: -1.0 (-) tags 69935 + moreinfo quit
Received: (at control) by debbugs.gnu.org; 2 Mar 2025 03:50:23 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Sat Mar 01 22:50:23 2025 Received: from localhost ([127.0.0.1]:49326 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1toaLP-0007lT-Do for submit <at> debbugs.gnu.org; Sat, 01 Mar 2025 22:50:23 -0500 Received: from mail-ed1-x532.google.com ([2a00:1450:4864:20::532]:54674) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>) id 1toaLN-0007iX-H2 for control <at> debbugs.gnu.org; Sat, 01 Mar 2025 22:50:21 -0500 Received: by mail-ed1-x532.google.com with SMTP id 4fb4d7f45d1cf-5dca468c5e4so5900926a12.1 for <control <at> debbugs.gnu.org>; Sat, 01 Mar 2025 19:50:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740887415; x=1741492215; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:from:from:to:cc:subject :date:message-id:reply-to; bh=SifYXcNcdqThsVzZv4CsZ3fLXfI90SOLq2U3sapB/2c=; b=kXCkSTW+YV04aqI+UVau3j4zZCM2m5cIOQi7z7HP0ajvoIsJKIhlPU6R9NqKnal2OO eimuUYFhTbQ9ztUKEI0DlWtSvaN6qg/5AmWPFa1bcm+Yxu6h0FrKlEh7MfHcf7/HVQeC 2HSc1t32ljeGQ+KktlpCxva2oZmH8jO3nPQKrqQjUGLy0QqpOtZ1gQGzCswQHRl64omc qCWCEtRJM2i0UN8f+VRAdwUvp78GeV7jVh3k2dhMEQk3GZurBQWhJnwRuqeO1pBGL8EZ x8LIwswhESu4+a9ND5XDVf1rb16a7Zv0nGtFMiRhxHTKXPhrhExvHX6yfiZpG7pU3XAa PbcA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740887415; x=1741492215; h=to:subject:message-id:date:mime-version:from:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=SifYXcNcdqThsVzZv4CsZ3fLXfI90SOLq2U3sapB/2c=; b=mtj0KpT78Ft4UvY0M4+0eJVMmY1oLeLPP9TNzcX65GRMQiFGxYmCBKI22Jt4BKyObA 8KNw/WXx9QvrcJAfUlcnw21P0GlnR5cZx9+MWG5s/eeOiOBWp2a6ifbmIQ2pzEBfcFCt 1Vg667E6oUR5U0HwOpdavVH27qpyb2/nVxoqb61SD/mrwaDl+i3joae7ROBIfneDwNZC RJ/cBRdkCgYMjx+/ex4pN2Cjq9N9C4Ubj7S8YFxiFYTsYjnzO0FLPl1KnjqIXYQueOsw YHMBxnooJ7UAy7+AX/2+yaorYPZJnZNPsuTDoYsRNtoE3zTTYyc9AgF78m98/Pz688VW xJ2g== X-Gm-Message-State: AOJu0YxcQ07WMncUdHQ8SGhfNja738uSdWAew56ReMoRXG2g94Jh25dJ vdpKHJ4ObwWb2t4eGYyIU99KwhmKhhkPQGMk+qsE7QYIQlBNCz2cK0mnWC5Zq4k9kg2g4gX9Vuc t/BG9Wrx8QyYOsGEHDAs1UWcBB/CbP0K9r9Q= X-Gm-Gg: ASbGncvMRB5oonO2+KjNMiNYwT7F0t/4eE135+TwHKBA3apnmdd7s6o7YD4AAsLce60 3toLk2xEyoOF+0QE9nADnsSmXnT/RgskpPirrRjKxLtYS/29zN9MA52s3eybqDnDRWA2UHHYxum na1BCoGDctu5Vd0ogUcUufLjXIBA== X-Google-Smtp-Source: AGHT+IHZGUPLcoz9QU+aaI0+luGqUUb9/spGcXSizPXtveAufbRNQUuwu6hVrh2cotn6o0BmR3YnAV9ghupq1g0bQA4= X-Received: by 2002:a05:6402:34d1:b0:5dc:c9ce:b022 with SMTP id 4fb4d7f45d1cf-5e4d6ade1a5mr8791431a12.9.1740887415342; Sat, 01 Mar 2025 19:50:15 -0800 (PST) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 1 Mar 2025 19:50:15 -0800 From: Stefan Kangas <stefankangas@HIDDEN> MIME-Version: 1.0 Date: Sat, 1 Mar 2025 19:50:15 -0800 X-Gm-Features: AQ5f1Jrxu7No8ou_sqQH5mMGWi1LfdPRt2glsIL0Cd-Udi94wEaRGiUgO0Ihaso Message-ID: <CADwFkm=vwdMats32WbXsKQOvfg=jMzDhUTPYgG1O8JwXgx_poA@HIDDEN> Subject: control message for bug #69935 To: control <at> debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> X-Spam-Score: -1.0 (-) severity 69935 wishlist quit
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997 nCipher Corporation Ltd,
1994-97 Ian Jackson.