From: John Yates <john@yates-sheets.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: nicolas.rougier@inria.fr, casouri@gmail.com, emacs-devel@gnu.org
Subject: Re: Question on set-window-margins
Date: Thu, 4 Jan 2024 07:29:00 -0500 [thread overview]
Message-ID: <CAJnXXog-iiHpAq7ggPs=K6VXRkQiehirMOFgBRGEi1v7oJ0Wkw@mail.gmail.com> (raw)
In-Reply-To: <83r0iyxsym.fsf@gnu.org>
On Wed, Jan 3, 2024 at 11:49 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> We do that when there are too many details to have them in the doc
> string. Otherwise, there's no need for a link because typing 'i' in
> the *Help* buffer will show the corresponding documentation in the
> manual.
A visual link has the virtue that it makes immediately clear case
holds. No link? Then the doc string is equivalent to what one
will find in the manual (or the function is not documented in any
manual). Link present? Then clearly there exists documentation
somewhere that goes beyond what is included in the doc string.
When I run describe function, along with the signature and the
actual doc string, I get additional boilerplate:
xxx-yyy-zzz is an autoloaded interactive byte-compiled Lisp
function in ‘xxx.el’.
<SIGNATURE>
<DOC STRING>
Probably introduced at or before Emacs version ee.v.
Help-mode binds 's' to help-view-source. That has prevented
us from supplying a visible link to the source. Similarly, I
suggest that, when there exists a relevant, more detailed bit
of documentation, the first line could be extended to read:
xxx-yyy-zzz is an autoloaded interactive byte-compiled Lisp
function in ‘xxx.el’. [full doc]
next prev parent reply other threads:[~2024-01-04 12:29 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 ` [External] : " Drew Adams
2024-01-04 12:29 ` John Yates [this message]
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='CAJnXXog-iiHpAq7ggPs=K6VXRkQiehirMOFgBRGEi1v7oJ0Wkw@mail.gmail.com' \
--to=john@yates-sheets.org \
--cc=casouri@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.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).