From: Juri Linkov <juri@linkov.net>
To: "Daniel Martín" <mardani29@yahoo.es>
Cc: me@wilfred.me.uk, Stefan Kangas <stefan@marxist.se>,
Arthur Miller <arthur.miller@live.com>,
Emacs developers <emacs-devel@gnu.org>
Subject: Re: Helpful in Emacs?
Date: Fri, 10 Sep 2021 09:30:53 +0300 [thread overview]
Message-ID: <8735qd7ywa.fsf@mail.linkov.net> (raw)
In-Reply-To: <m1a6klu64l.fsf@yahoo.es> ("Daniel Martín"'s message of "Thu, 09 Sep 2021 17:21:30 +0200")
> Instead of integrating the library as a whole, I'd prefer we extract
> those features from Helpful that people think are useful and not already
> available in Emacs. I don't think that having two separate help systems
> in core is a good idea, there'll be too much duplication and maintenance
> burden.
Refactoring it as a library is very much needed. Ideally, it should return
information in a structured way, for example:
((type . function)
(name . "car")
(source-file . "src/data.c")
(Info-node . "(elisp) List Elements")
(docstring . ...)
...)
This will allow to use the extracted information in different front-ends
such as a html front-end to display Help in eww, etc. I once attempted
to represent such information as a generated Info node, but abandoned
due to too many small details that are too ambiguous to handle.
If it's possible to refactor helpful.el and separate a library from front-end,
it would be very helpful and will solve such bugs as bug#49587 that currently
displays the Help buffer twice: for the function and the variable part
separately when a symbol for 'C-h o' is both a function and a variable.
prev parent reply other threads:[~2021-09-10 6:30 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-09 10:57 Helpful in Emacs? Arthur Miller
2021-09-09 11:34 ` Stefan Kangas
2021-09-09 12:35 ` Arthur Miller
2021-09-09 15:21 ` Daniel Martín
2021-09-09 15:48 ` Arthur Miller
2021-09-10 6:20 ` Stefan Kangas
2021-09-10 7:11 ` Arthur Miller
2021-09-10 7:19 ` Stefan Kangas
2021-09-10 7:58 ` Arthur Miller
2021-09-10 8:14 ` Jean-Christophe Helary
2021-09-10 12:32 ` Stefan Monnier
2021-09-10 7:26 ` Eli Zaretskii
2021-09-10 8:00 ` Arthur Miller
2021-09-10 11:14 ` Eli Zaretskii
2021-09-10 11:41 ` Arthur Miller
2021-09-09 19:21 ` Eduardo Ochs
2021-09-09 19:51 ` Arthur Miller
2021-09-09 20:23 ` Arthur Miller
2021-09-09 22:55 ` Dmitry Gutov
2021-09-10 0:52 ` Arthur Miller
2021-09-10 6:16 ` Eli Zaretskii
2021-09-10 6:06 ` Eli Zaretskii
2021-09-10 6:21 ` Arthur Miller
2021-09-10 6:30 ` Juri Linkov [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=8735qd7ywa.fsf@mail.linkov.net \
--to=juri@linkov.net \
--cc=arthur.miller@live.com \
--cc=emacs-devel@gnu.org \
--cc=mardani29@yahoo.es \
--cc=me@wilfred.me.uk \
--cc=stefan@marxist.se \
/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).