From: Miles Bader <miles.bader@necel.com>
Cc: emacs-devel@gnu.org
Subject: Re: doc string for face-attribute-relative-p doesn't help
Date: Tue, 27 Jun 2006 12:52:37 +0900 [thread overview]
Message-ID: <buolkrjs1a2.fsf@dhapc248.dev.necel.com> (raw)
In-Reply-To: <EIENLHALHGIMHGDOLMIMEECJCJAA.drew.adams@oracle.com> (Drew Adams's message of "Mon, 26 Jun 2006 20:33:03 -0700")
"Drew Adams" <drew.adams@oracle.com> writes:
> I agree, too, that each function's doc string need not try to explain
> everything. If the doc defines the terms it uses (e.g. "underlying",
> "relative") and explains them clearly, then that lessens the burden of
> explanation for doc strings.
I've always wondered if there should be more attempts to link from
docstrings into the elisp manual. It would reduce the burden
of trying to make docstrings too all-encompassing.
Consider, for instance, if there were automatically added "See
(elisp)FUNCTION-NAME" and/or "See (elisp)faces" links at the bottom of
_every_ face function's docstring.
[I seem to recall that this was discussed in some manner before??
Anybody remember?]
-miles
--
o The existentialist, not having a pillow, goes everywhere with the book by
Sullivan, _I am going to spit on your graves_.
next prev parent reply other threads:[~2006-06-27 3:52 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <MEEKKIABFKKDFJMPIOEBKEIGDCAA.drew.adams@oracle.com>
2006-06-25 15:33 ` doc string for face-attribute-relative-p doesn't help Richard Stallman
2006-06-26 4:39 ` Miles Bader
2006-06-26 7:45 ` David Kastrup
2006-06-26 16:17 ` Drew Adams
2006-06-27 2:08 ` Miles Bader
2006-06-27 3:33 ` Drew Adams
2006-06-27 3:52 ` Miles Bader [this message]
2006-06-27 4:27 ` Drew Adams
2006-06-27 16:16 ` Richard Stallman
2006-06-28 6:41 ` Miles Bader
2006-06-26 11:13 ` John S. Yates, Jr.
2006-06-26 10:57 ` Miles Bader
2006-06-26 12:28 ` John S. Yates, Jr.
2006-06-27 2:12 ` Miles Bader
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=buolkrjs1a2.fsf@dhapc248.dev.necel.com \
--to=miles.bader@necel.com \
--cc=emacs-devel@gnu.org \
--cc=miles@gnu.org \
/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).