[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: doc string for face-attribute-relative-p doesn't help
From: |
Miles Bader |
Subject: |
Re: doc string for face-attribute-relative-p doesn't help |
Date: |
Tue, 27 Jun 2006 12:52:37 +0900 |
"Drew Adams" <address@hidden> 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_.
- Re: doc string for face-attribute-relative-p doesn't help, Richard Stallman, 2006/06/25
- Re: doc string for face-attribute-relative-p doesn't help, Miles Bader, 2006/06/26
- Re: doc string for face-attribute-relative-p doesn't help, David Kastrup, 2006/06/26
- RE: doc string for face-attribute-relative-p doesn't help, Drew Adams, 2006/06/26
- Re: doc string for face-attribute-relative-p doesn't help, Miles Bader, 2006/06/26
- RE: doc string for face-attribute-relative-p doesn't help, Drew Adams, 2006/06/26
- Re: doc string for face-attribute-relative-p doesn't help,
Miles Bader <=
- RE: doc string for face-attribute-relative-p doesn't help, Drew Adams, 2006/06/27
- Re: doc string for face-attribute-relative-p doesn't help, Richard Stallman, 2006/06/27
- Re: doc string for face-attribute-relative-p doesn't help, Miles Bader, 2006/06/28
Re: doc string for face-attribute-relative-p doesn't help, John S. Yates, Jr., 2006/06/26