From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, John Yates <john@yates-sheets.org>
Cc: "nicolas.rougier@inria.fr" <nicolas.rougier@inria.fr>,
"casouri@gmail.com" <casouri@gmail.com>,
"emacs-devel@gnu.org" <emacs-devel@gnu.org>
Subject: RE: [External] : Re: Question on set-window-margins
Date: Wed, 3 Jan 2024 20:07:58 +0000 [thread overview]
Message-ID: <SJ0PR10MB548826E1585DDC4974F02824F360A@SJ0PR10MB5488.namprd10.prod.outlook.com> (raw)
In-Reply-To: <83r0iyxsym.fsf@gnu.org>
> > Might there be a way for a doc string to include an unobtrusive
> > small link to the full documentation?
This has been suggested multiple times over the years.
I added it to *Help* in my library help-fns+.el in 2011.
A user option controls whether such a link is shown, and
if so, which manuals to check, and whether to check
automatically or only when you click the link.
> We do that when there are too many details to have them
> in the doc string.
Other reasons to do it are that the manual can provide
additional context, links, etc. It's not only about
more details about the thing described in *Help*.
> Otherwise, there's no need for a link because typing 'i' in
> the *Help* buffer will show the corresponding documentation in the
> manual.
No need? Can't argue about need. But a link is more
obvious than knowing, or checking to find, binding `i'.
IOW, need or no need, a link to the manuals is useful.
___
https://www.emacswiki.org/emacs/HelpPlus#LinksToManuals
https://www.emacswiki.org/emacs/download/help-fns%2b.el
next prev parent reply other threads:[~2024-01-03 20:07 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-02 17:58 Question on set-window-margins Nicolas P. Rougier (inria)
2024-01-02 19:20 ` Eli Zaretskii
2024-01-02 19:46 ` Nicolas P. Rougier (inria)
2024-01-03 3:23 ` Eli Zaretskii
2024-01-03 3:42 ` Yuan Fu
2024-01-03 5:50 ` Nicolas P. Rougier (inria)
2024-01-03 13:15 ` Eli Zaretskii
2024-01-03 14:05 ` Nicolas P. Rougier (inria)
2024-01-03 16:46 ` Eli Zaretskii
2024-01-03 17:24 ` Nicolas P. Rougier (inria)
2024-01-03 17:28 ` Eli Zaretskii
2024-01-03 17:56 ` Nicolas P. Rougier (inria)
2024-01-03 21:52 ` Jeremy Bryant
2024-01-04 8:53 ` Nicolas P. Rougier (inria)
2024-01-03 15:11 ` John Yates
2024-01-03 16:49 ` Eli Zaretskii
2024-01-03 20:07 ` Drew Adams [this message]
2024-01-04 12:29 ` John Yates
2024-01-04 12:52 ` Eli Zaretskii
2024-01-05 0:25 ` Yuan Fu
2024-01-05 8:01 ` Eli Zaretskii
2024-01-06 4:35 ` Richard Stallman
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=SJ0PR10MB548826E1585DDC4974F02824F360A@SJ0PR10MB5488.namprd10.prod.outlook.com \
--to=drew.adams@oracle.com \
--cc=casouri@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=john@yates-sheets.org \
--cc=nicolas.rougier@inria.fr \
/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).