* bug#9156: 24.0.50; `apropos' doc in Elisp manual
@ 2011-07-23 17:36 Drew Adams
2011-09-11 1:38 ` Lars Magne Ingebrigtsen
2012-02-19 5:55 ` Chong Yidong
0 siblings, 2 replies; 4+ messages in thread
From: Drew Adams @ 2011-07-23 17:36 UTC (permalink / raw)
To: 9156
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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9156: 24.0.50; `apropos' doc in Elisp manual
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
2011-09-11 14:34 ` Drew Adams
2012-02-19 5:55 ` Chong Yidong
1 sibling, 1 reply; 4+ messages in thread
From: Lars Magne Ingebrigtsen @ 2011-09-11 1:38 UTC (permalink / raw)
To: Drew Adams; +Cc: 9156
"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/
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9156: 24.0.50; `apropos' doc in Elisp manual
2011-09-11 1:38 ` Lars Magne Ingebrigtsen
@ 2011-09-11 14:34 ` Drew Adams
0 siblings, 0 replies; 4+ messages in thread
From: Drew Adams @ 2011-09-11 14:34 UTC (permalink / raw)
To: 'Lars Magne Ingebrigtsen'; +Cc: 9156
> 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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9156: 24.0.50; `apropos' doc in Elisp manual
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
@ 2012-02-19 5:55 ` Chong Yidong
1 sibling, 0 replies; 4+ messages in thread
From: Chong Yidong @ 2012-02-19 5:55 UTC (permalink / raw)
To: Drew Adams; +Cc: 9156
"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.
They are now described. Closing.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2012-02-19 5:55 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2011-09-11 14:34 ` Drew Adams
2012-02-19 5:55 ` Chong Yidong
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).