From: Lars Magne Ingebrigtsen <larsi@gnus.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 9156@debbugs.gnu.org
Subject: bug#9156: 24.0.50; `apropos' doc in Elisp manual
Date: Sun, 11 Sep 2011 03:38:45 +0200 [thread overview]
Message-ID: <m3litv97tm.fsf@stories.gnus.org> (raw)
In-Reply-To: <63826CEAD8D342239444E86F6B6A446B@us.oracle.com> (Drew Adams's message of "Sat, 23 Jul 2011 10:36:37 -0700")
"Drew Adams" <drew.adams@oracle.com> writes:
> (elisp) Help Functions says this in its attempt to describe command
> `apropos':
>
> The function returns a list of elements that look like this:
>
> (SYMBOL SCORE FN-DOC VAR-DOC
> PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC)
>
> None of those introduced (meta) names is defined/described, apart from
> SCORE. This description of the return value is meaningless and not
> helpful. The doc needs to describe such terms that it introduces.
I know nothing about any of this, but it's obvious to me that "VAR-DOC"
means "documentation of the symbol if it's a variable", and so on. The
only thing that needs further documentation is SCORE, which is
documented.
So I don't think this is a bug.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
next prev parent reply other threads:[~2011-09-11 1:38 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-07-23 17:36 bug#9156: 24.0.50; `apropos' doc in Elisp manual Drew Adams
2011-09-11 1:38 ` Lars Magne Ingebrigtsen [this message]
2011-09-11 14:34 ` Drew Adams
2012-02-19 5:55 ` Chong Yidong
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=m3litv97tm.fsf@stories.gnus.org \
--to=larsi@gnus.org \
--cc=9156@debbugs.gnu.org \
--cc=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 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).