unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Daniel Martín" <mardani29@yahoo.es>
To: Arthur Miller <arthur.miller@live.com>
Cc: Stefan Kangas <stefan@marxist.se>,
	 me@wilfred.me.uk,  Emacs developers <emacs-devel@gnu.org>
Subject: Re: Helpful in Emacs?
Date: Thu, 09 Sep 2021 17:21:30 +0200	[thread overview]
Message-ID: <m1a6klu64l.fsf@yahoo.es> (raw)
In-Reply-To: <AM9PR09MB4977AF3D5B2D213D6A26E8CE96D59@AM9PR09MB4977.eurprd09.prod.outlook.com> (Arthur Miller's message of "Thu, 09 Sep 2021 14:35:47 +0200")

Arthur Miller <arthur.miller@live.com> writes:

> A week or two ago I was actually looking at Emacs help code. I wanted to bring
> in the source code as well as references into help lookup, but honestly, I would
> rather prefer to just include helpful instead of re-implementing everything. If
> the authors have signed the paperwork, I see no reason why not just include
> it. Also original help lookup could be left as low-resource, faster solution for
> people who prefer to spend less resources on help lookup, while helpful could be
> enabled by a custom variable, something like show extended help or as
> a minor mode.

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.

Showing references to a symbol is an interesting feature (for example,
to learn how to use an ELisp API by looking at examples).  I see that
Helpful provides this feature via the separate package elisp-refs
(https://github.com/Wilfred/elisp-refs).  The closest package I know
that actually understands ELisp is el-search from ELPA, but elisp-refs
is a more specific package for the concrete use case of searching for
references.

If we can get copyright papers, perhaps we could start by integrating
the functionality of elisp-refs as an xref backend.  Then the help
system could use the new backend to provide a "References" link button.



  reply	other threads:[~2021-09-09 15:21 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 [this message]
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

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=m1a6klu64l.fsf@yahoo.es \
    --to=mardani29@yahoo.es \
    --cc=arthur.miller@live.com \
    --cc=emacs-devel@gnu.org \
    --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).