GNU bug report logs - #40773
newsticker documentation

Previous Next

Full log

View this message in rfc822 format

From: Boruch Baum <boruch_baum <at> gmx.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: ulf.jasper <at> web.de, 40773 <at> debbugs.gnu.org
Subject: bug#40773: newsticker documentation
Date: Wed, 29 Apr 2020 14:55:54 -0400

On 2020-04-29 12:34, Eli Zaretskii wrote:
> > Date: Wed, 29 Apr 2020 05:12:13 -0400
> > > > Further, as a corollary, I suggest that packages bundled in the default
> > > > emacs distribution should NOT have info nodes in the emacs section of
> > > > the root info index, ie. no duplication. Either the emacs section of the
> > > > root info index should be restricted to non-default emacs packages, or
> > > > there shouldn't exist such a section at all, and the emacs manual should
> > > > have a section for external packages.
> > >
> > > I don't think I understand what you propose here.  What is "the root
> > > info index"? is that the Emacs menu in the DIR file
> >
> > That sounds right. I meant  what I see when I type `C-h i'.
>
> Then I don't understand the rationale for removing the entries from
> there.  What useful purpose would that serve?

It manages and guides users' expectations. Emacs should have a single
authoritative manual, and users should feel confident that they can turn
to a single place for the comprehensive documentation. When you
partially duplicate components in a second place, you confuse beginner
users as to where to turn for documentation.

If it were up to me, the entire Emacs section for M-x info would have just
three entries:

Emacs
* The emacs manual             All the features of the default emacs
* Your emacs extensions        Docs for the add-ons you've installed
* Other emacs help             Ways to quickly find information

The third entry would point to content similar to what is displayed by
M-x help-for-help (C-h ?), but also mentioning M-x info-display-manual,
and whatever other constructive input gets suggested.

--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1  7286 0036 9E45 1595 8BC0

Previous Next

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