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

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 9156 in the body.
You can then email your comments to 9156 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50; `apropos' doc in Elisp manual
Date: Sat, 23 Jul 2011 10:36:37 -0700

NOTE: Sending this from a different Emacs version, since bug reporting
from emacs -Q is completely broken in this version:
 
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-07-18 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'

---------------

emacs -Q
 
(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.
 
 
 
 
 

 

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/

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 9156 <at> debbugs.gnu.org
Subject: RE: 24.0.50; `apropos' doc in Elisp manual
Date: Sun, 11 Sep 2011 07:34:15 -0700

> 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.

Reopening.  The bug report stands.
If the missing description is obvious to you, then add it.

It's about Emacs and Lisp users; it's not about you.

Message #16 received at 9156-close <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-close <at> debbugs.gnu.org
Subject: Re: 24.0.50; `apropos' doc in Elisp manual
Date: Sun, 11 Sep 2011 16:43:17 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> If the missing description is obvious to you, then add it.

Adding verbiage that's obvious to anybody doesn't help anybody.  Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

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

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9156 <at> debbugs.gnu.org
Subject: Re: bug#9156: 24.0.50; `apropos' doc in Elisp manual
Date: Sun, 19 Feb 2012 13:55:07 +0800

"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.

They are now described.  Closing.

Previous Next

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