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: Raffaele Ricciardi
Subject: Re: Info documentation does not match Help documentation
Date: Thu, 16 Aug 2012 22:24:17 +0100
User-agent: Mozilla/5.0 (X11; Linux i686; rv:14.0) Gecko/20120713 Thunderbird/14.0

On 08/16/2012 08:55 PM, Eli Zaretskii wrote:
>> From: Raffaele Ricciardi <rfflrccrd@gmail.com>
>> Date: Thu, 16 Aug 2012 18:52:42 +0100
>>
>> 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".
>

Thank you for the explanation.  In my opinion, this leads to more work than
necessary for the maintainers. It leads to more work for users, too, for they
may have to read two versions of mostly the same documentation, or they may
resolve - as I've done - to always look into the Info documentation when
available, in case they might be missing something. Duplication is evil, isn't
it? ;-)


reply via email to

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