From: Andrea Corallo <acorallo@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 65288@debbugs.gnu.org, philipk@posteo.net,
Visuwesh <visuweshm@gmail.com>
Subject: bug#65288: 30.0.50; Make Type: annotation optional in *Help* buffers
Date: Sun, 20 Aug 2023 06:11:20 -0400 [thread overview]
Message-ID: <yp1zg2m81mf.fsf@fencepost.gnu.org> (raw)
In-Reply-To: <83350f1lmy.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 19 Aug 2023 11:28:37 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
>> Cc: 65288@debbugs.gnu.org
>> From: Visuwesh <visuweshm@gmail.com>
>> Date: Mon, 14 Aug 2023 20:47:31 +0530
>>
>> [திங்கள் ஆகஸ்ட் 14, 2023] Philip Kaludercic wrote:
>>
>> > Visuwesh <visuweshm@gmail.com> writes:
>> >
>> >> Can a user option be added to not show the "Type:" annotation in *Help*
>> >> buffers for certain functions? An example is `char-after'
>> >>
>> >> char-after is a built-in function in ‘src/editfns.c’.
>> >>
>> >> (char-after &optional POS) Type: (function (&optional (or marker
>> >> integer)) (or null (integer -2305843009213693952
>> >> 2305843009213693951)))
>> >>
>> >> Return character in current buffer at position POS.
>> >> POS is an integer or a marker and defaults to point.
>> >> If POS is out of range, the value is nil.
>> >>
>> >> If not a user option, can it be moved after the docstring?
>> >
>> > Only functions have types, these are not the same types those given to
>> > user options.
>>
>> There's no confusion about user option type and function argument type
>> but this info crowds the second line which only contained the function
>> signature before. Other extra info are at the bottom of the buffer so
>> moving it there would be more consistent too.
>>
>> > That being said, I agree that in cases like `char-after' the information
>> > of a very specific type like that one is limited. I don't know if there
>> > is a sensible heuristic to reformat the type into something like
>> >
>> > (function (&optional position) (or position null))
>> >
>> > using some kind of type aliasing, but it might be better to not
>> > highlight the information so prominently?
>
> Andrea, would it make sense to introduce an option which could disable
> showing this information in *Help*?
Hi Eli,
sure why not, something like `help-enable-function-type'?
Thanks
Andrea
next prev parent reply other threads:[~2023-08-20 10:11 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-14 12:29 bug#65288: 30.0.50; Make Type: annotation optional in *Help* buffers Visuwesh
2023-08-14 13:51 ` Philip Kaludercic
2023-08-14 14:25 ` Helmut Eller
2023-08-14 14:44 ` Philip Kaludercic
2023-08-14 15:13 ` Helmut Eller
2023-08-14 16:03 ` Philip Kaludercic
2023-08-14 17:11 ` Helmut Eller
2023-08-14 15:17 ` Visuwesh
2023-08-19 8:28 ` Eli Zaretskii
2023-08-19 9:53 ` Gregory Heytings
2023-08-20 10:11 ` Andrea Corallo [this message]
[not found] ` <CA38BAAD-3FC3-4345-8F86-47E61AD4A92F@posteo.net>
2023-08-20 10:24 ` Andrea Corallo
2023-08-20 12:19 ` Philip Kaludercic
2023-08-20 10:37 ` Eli Zaretskii
2023-08-20 20:39 ` Andrea Corallo
2023-08-21 12:15 ` Eli Zaretskii
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=yp1zg2m81mf.fsf@fencepost.gnu.org \
--to=acorallo@gnu.org \
--cc=65288@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=philipk@posteo.net \
--cc=visuweshm@gmail.com \
/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).