emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: master 2a7488d: Add support for displaying short documentation for f


From: Gregory Heytings
Subject: RE: master 2a7488d: Add support for displaying short documentation for function groups
Date: Mon, 12 Oct 2020 08:05:00 +0000
User-agent: Alpine 2.22 (NEB 394 2020-01-19)


I think the manual gives superior information in most cases, so I'd really like this to link to the manual and not the doc strings. This is also a way to guide users into the manual and read more in-depth about not just the functions described, but the machinery surrounding them, giving them more context.

*Help* should have a link to the relevant manual node. See thread "How to make Emacs popular again." That's not hard to do, and it's been done (e.g. in `help-fns+.el').


As I already explained repeatedly, this is _not_ the meaning of my proposal in that thread.

My proposal is to _manually_ add pointers to the relevant manual _chapters_ in docstrings. For example, the docstring of kill-buffer would have two links, one to (info "(emacs)Buffers") and another one to (info "(elisp)Buffers"), with some explanation. For example:

See also the following manual chapters: for interactive use, see `(emacs) Buffers'; for Emacs Lisp programming use, see `(elisp) Buffers'.

Your proposal is to merge a feature of help-fns+.el in help-fns.el. This feature adds a link in *Help* buffers, and when the user clicks on that link the indexes of a (user chosen) list of manuals are checked to see if they contain pointers to the subject of the *Help* buffer. Doing this is, as you said yourself, inefficient. The result of this scan is presented in another buffer as a list of links, and when the user clicks on these links the place where the subject of the *Help* buffer is documented in the manual is displayed.

These are two very different proposals.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]