unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Boruch Baum <boruch_baum@gmx.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 40773@debbugs.gnu.org
Subject: bug#40773: newsticker documentation
Date: Wed, 29 Apr 2020 14:55:54 -0400	[thread overview]
Message-ID: <20200429185554.wd2byg5lksp7ngj5@E15-2016.optimum.net> (raw)
In-Reply-To: <83v9lizlcu.fsf@gnu.org>

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





  reply	other threads:[~2020-04-29 18:55 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-22 15:55 bug#40773: newsticker documentation Boruch Baum
2020-04-28 13:08 ` Ulf Jasper
2020-04-29  4:18   ` Boruch Baum
2020-04-29  7:58     ` Eli Zaretskii
2020-04-29  9:12       ` Boruch Baum
2020-04-29  9:34         ` Eli Zaretskii
2020-04-29 18:55           ` Boruch Baum [this message]
2020-04-29 19:14             ` Eli Zaretskii
2020-04-29 19:25               ` Boruch Baum
2020-04-29 19:13           ` Boruch Baum
2022-02-07  1:19       ` Lars Ingebrigtsen

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=20200429185554.wd2byg5lksp7ngj5@E15-2016.optimum.net \
    --to=boruch_baum@gmx.com \
    --cc=40773@debbugs.gnu.org \
    --cc=eliz@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 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).