help-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: Info documentation does not match Help documentation


From: Drew Adams
Subject: RE: Info documentation does not match Help documentation
Date: Thu, 16 Aug 2012 17:51:16 -0700

> > I've noticed that the documentation for a symbol in Info mode
> > doesn't match the documentation for the same symbol in Help mode.  I
> > expected both documentations to be the documentation string of the
> > symbol.  Am I missing something?
> 
> The text you see doesn't have to be identical, as it comes from two
> different places and serves different purposes.  "C-h S" brings the
> relevant section from the manual, which describes the topic in more
> detail.  By contrast, the doc string comes from the code itself, and
> is a concise description of the symbol, and it alone.
> 
> The information should be similar and consistent, though.  If you spot
> any inconsistencies, please report them as bugs using "M-x
> report-emacs-bug".

+1 for what Eli said.  I would add that the description in the manual can also
be different because it is in a particular context.  It is typically surrounded
by text that provides more background and puts it in relation with other things.

A manual, even a purely reference manual (and the Elisp manual is part
reference, part user guide), is not just a list of APIs with no explanation.  At
the very least, it groups related APIs together.  That provides helpful context
that is not available in a doc string.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]