From: Arthur Miller <arthur.miller@live.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Patch proposal: display symbol source code in help buffers
Date: Mon, 20 Sep 2021 17:11:00 +0200 [thread overview]
Message-ID: <AM9PR09MB4977683D05E6D449CCFAEBA896A09@AM9PR09MB4977.eurprd09.prod.outlook.com> (raw)
In-Reply-To: <83bl4n3hys.fsf@gnu.org> (Eli Zaretskii's message of "Mon, 20 Sep 2021 08:59:39 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Arthur Miller <arthur.miller@live.com>
>> Date: Sun, 19 Sep 2021 21:50:35 +0200
>>
>> Here is my second proposal to bring built-in help on par with external
>> offerings.
>
> Thanks. Like Lars, I wonder why this is needed, given that we already
> have a way to show the sources by a command invoked from the *Help*
> buffer. Can you tell how this feature makes a difference wrt what we
> have already?
I just answered to I think Lars or Stefan's answer to Lars, where I elaborate a
bit more why is it useful, if you can peek there, it would be nice so I dont'
need to re-write everything. Short summary:
- people new to Emacs are maybe not so inclined to look at the code, having code
auto displayed makes at least me more inclined to actually look at the sources
so, I think it has some educational purpose
- I don't always want to deep dive into the source, sometimes I just glimpse
over to confirm my (mis)understanding :).
- no extra action needed to take to see the source (switch to buffer, hit 's)
- sometimes the source is just a wrapper, so I will need to perform a search in
the source file, here I can actually hit C-h f on the symbol in help buffer
and opened that function directly
- people are used to Helpful
- it is on a defcustom, nil by default, so having it as an opt-in does not cost
much
> And a minor nit:
>
>> * lisp/help-mode.el ('help-mode-inline-source'): New option.
>> ('help--fetch-c-src'): New function.
>> ('help--fetch-lisp-src'): New function.
>> ('help--symbol-source'): New function.
>> ('help-make-xrefs): Check for 'help-mode-inline-source' and
>> call 'help--symbol-source' to perform insertion when possible.
>
> We don't quote symbols inside the parentheses, only in the
> descriptions that follow the colon, as you did in the last entry.
Aha, yes yes, thanks, I'll remember that for the next time.
prev parent reply other threads:[~2021-09-20 15:11 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-19 19:50 Patch proposal: display symbol source code in help buffers Arthur Miller
2021-09-20 5:46 ` Lars Ingebrigtsen
2021-09-20 6:09 ` Stefan Kangas
2021-09-20 6:14 ` Lars Ingebrigtsen
2021-09-20 7:17 ` Ihor Radchenko
2021-09-20 7:43 ` Stefan Kangas
2021-09-20 8:29 ` martin rudalics
2021-09-20 9:04 ` Ihor Radchenko
2021-09-20 23:45 ` Arthur Miller
2021-09-21 4:16 ` Lars Ingebrigtsen
2021-09-21 6:59 ` Ihor Radchenko
2021-09-21 7:41 ` Stefan Kangas
2021-09-21 8:38 ` Eli Zaretskii
2021-09-21 9:17 ` Ihor Radchenko
2021-09-21 16:49 ` Lars Ingebrigtsen
2021-10-01 7:05 ` Ihor Radchenko
2021-10-01 7:09 ` Lars Ingebrigtsen
2021-10-01 7:21 ` Ihor Radchenko
2021-10-01 7:21 ` Lars Ingebrigtsen
2021-10-01 9:04 ` Ihor Radchenko
2021-10-01 12:20 ` Lars Ingebrigtsen
2021-10-01 7:24 ` Eli Zaretskii
2021-10-01 9:08 ` Ihor Radchenko
2021-10-01 10:24 ` Eli Zaretskii
2021-10-01 14:14 ` Ihor Radchenko
2021-09-21 8:34 ` martin rudalics
2021-09-20 15:01 ` Arthur Miller
2021-09-21 7:41 ` Stefan Kangas
2021-09-20 15:27 ` Arthur Miller
2021-09-20 6:47 ` Eli Zaretskii
2021-09-20 15:27 ` Arthur Miller
2021-09-20 14:55 ` Arthur Miller
2021-09-21 4:18 ` Lars Ingebrigtsen
2021-09-21 10:26 ` Arthur Miller
2021-09-20 15:23 ` Arthur Miller
2021-09-20 5:59 ` Eli Zaretskii
2021-09-20 6:37 ` Gregor Zattler
2021-09-20 7:01 ` Eli Zaretskii
2021-09-20 15:21 ` Arthur Miller
2021-09-20 8:21 ` martin rudalics
2021-09-20 18:13 ` Arthur Miller
2021-09-21 8:34 ` martin rudalics
2021-09-21 10:24 ` Arthur Miller
2021-09-21 16:52 ` martin rudalics
2021-09-21 18:56 ` Arthur Miller
2021-09-21 17:30 ` Juri Linkov
2021-09-21 19:13 ` Arthur Miller
2021-09-22 7:49 ` martin rudalics
2021-09-22 16:04 ` Juri Linkov
2021-09-22 17:52 ` martin rudalics
2021-09-23 8:15 ` martin rudalics
2021-09-23 15:52 ` Juri Linkov
2021-09-26 9:10 ` martin rudalics
2021-09-22 22:38 ` Arthur Miller
2021-09-23 8:22 ` martin rudalics
2021-09-20 12:19 ` Dmitry Gutov
2021-09-20 15:13 ` Arthur Miller
2021-09-20 15:11 ` Arthur Miller [this message]
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=AM9PR09MB4977683D05E6D449CCFAEBA896A09@AM9PR09MB4977.eurprd09.prod.outlook.com \
--to=arthur.miller@live.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
/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).