GNU bug report logs - #9156
24.0.50; `apropos' doc in Elisp manual

Previous Next

Full log

Message #12 received at 9156 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9156 <at> debbugs.gnu.org
Subject: Re: 24.0.50; `apropos' doc in Elisp manual
Date: Sun, 11 Sep 2011 03:38:45 +0200

"Drew Adams" <drew.adams <at> 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/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.