From: "Drew Adams" <drew.adams@oracle.com>
Subject: how to retrieve doc string for a face...
Date: Sat, 19 Nov 2005 23:53:14 -0800 [thread overview]
Message-ID: <MEEKKIABFKKDFJMPIOEBMEJCCNAA.drew.adams@oracle.com> (raw)
Info node (elisp) Accessing Documentation says this:
"In Emacs Lisp, a documentation string is accessible through the
function or variable that it describes:"
And then it speaks of using functions `documentation' and
`documentation-property'.
It says nothing about retrieving the doc string supplied with `defface' or
`defgroup' or `defmacro' or ....
1. How are those doc strings retrieved? (e.g. `face-documentation')
2. Shouldn't that retrieval be documented too?
3. Info mentions the `function-documentation' property, in parallel with the
`variable-documentation' property. Is there no equivalent shortcut to
`documentation-property' for retrieving the doc string of a keyboard macro,
so that you must use `get'? Similarly, for properties `face-documentation',
`group-documentation', etc. (which are not even mentioned).
This business of retrieving doc strings doesn't seem very homogeneous - it
seems ad hoc. Shouldn't there be a simple, single way to get the doc
string(s) of an object?
If the same symbol has multiple doc strings, then that simple function would
need to let you specify which one(s) you want - by taking, for instance, a
TYPE argument, which could be a symbol such as `face' or a list of such
symbols. In the latter case, it would return the list (same order) of doc
strings. nil would be used to indicate that there is no doc string of the
given type.
I may not understand the design well, so that the above suggestion is not
appropriate, but I think that the manual, at least, should be more complete
on this matter. Even if completeness is not priority #1, node "Accessing
Documentation" should say more than it does.
next reply other threads:[~2005-11-20 7:53 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-11-20 7:53 Drew Adams [this message]
2005-11-20 23:23 ` how to retrieve doc string for a face Richard M. 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=MEEKKIABFKKDFJMPIOEBMEJCCNAA.drew.adams@oracle.com \
--to=drew.adams@oracle.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.