all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Raffaele Ricciardi <rfflrccrd@gmail.com>
To: help-gnu-emacs@gnu.org
Subject: Re: Info documentation does not match Help documentation
Date: Thu, 16 Aug 2012 22:24:17 +0100	[thread overview]
Message-ID: <a956o7F7qcU1@mid.individual.net> (raw)
In-Reply-To: <mailman.7120.1345146916.855.help-gnu-emacs@gnu.org>

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? ;-)


  parent reply	other threads:[~2012-08-16 21:24 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-16 17:52 Info documentation does not match Help documentation Raffaele Ricciardi
2012-08-16 19:55 ` Eli Zaretskii
2012-08-17  0:51   ` Drew Adams
     [not found] ` <mailman.7120.1345146916.855.help-gnu-emacs@gnu.org>
2012-08-16 21:24   ` Raffaele Ricciardi [this message]
2012-08-16 21:40     ` drain
     [not found]     ` <mailman.7125.1345153237.855.help-gnu-emacs@gnu.org>
2012-08-16 22:28       ` Raffaele Ricciardi
2012-08-17  6:39     ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a956o7F7qcU1@mid.individual.net \
    --to=rfflrccrd@gmail.com \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.