From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#69935: [PATCH] (help-fns-function-description-header): Print functions' type Date: Sat, 23 Mar 2024 08:44:09 +0200 Message-ID: <86v85dzbuu.fsf@gnu.org> References: <86edc220e1.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32577"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 69935@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 23 07:47:51 2024 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 1rnvAV-0008HN-Hi for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 23 Mar 2024 07:47:51 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rnvA4-0003BE-Mm; Sat, 23 Mar 2024 02:47:24 -0400 Original-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 ) id 1rnvA2-0003B6-3U for bug-gnu-emacs@gnu.org; Sat, 23 Mar 2024 02:47:22 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rnvA1-0004gD-RX for bug-gnu-emacs@gnu.org; Sat, 23 Mar 2024 02:47:21 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rnvAg-0000fZ-Ib for bug-gnu-emacs@gnu.org; Sat, 23 Mar 2024 02:48:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 23 Mar 2024 06:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69935 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 69935-submit@debbugs.gnu.org id=B69935.17111764332451 (code B ref 69935); Sat, 23 Mar 2024 06:48:02 +0000 Original-Received: (at 69935) by debbugs.gnu.org; 23 Mar 2024 06:47:13 +0000 Original-Received: from localhost ([127.0.0.1]:57759 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rnv9s-0000dS-LU for submit@debbugs.gnu.org; Sat, 23 Mar 2024 02:47:13 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:47152) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rnv9q-0000dA-65 for 69935@debbugs.gnu.org; Sat, 23 Mar 2024 02:47:11 -0400 Original-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 ) 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==; In-Reply-To: (message from Stefan Monnier on Fri, 22 Mar 2024 17:14:40 -0400) 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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:281963 Archived-At: > From: Stefan Monnier > Cc: 69935@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.