unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Boruch Baum <boruch_baum@gmx.com>
To: Ulf Jasper <ulf.jasper@web.de>
Cc: 40773@debbugs.gnu.org
Subject: bug#40773: newsticker documentation
Date: Wed, 29 Apr 2020 00:18:15 -0400	[thread overview]
Message-ID: <20200429041745.srdhgypy5v27e3mv@E15-2016.optimum.net> (raw)
In-Reply-To: <87h7x33ggs.fsf@panama>

On 2020-04-28 15:08, Ulf Jasper wrote:
> Am 22.04.2020 um 11:55 (-0400) schrieb Boruch Baum:
> > I just discovered the existence of `newsticker' bundled into emacs;
> > however, I see not even a cursory mention of it in the emacs manual. At
> > the very least, there should be a short stub entry in the emacs manual,
> > next to the index entry for
> >
> >    * Gnus::                A flexible mail and news reader.
>
> You should find newsticker documentation in its own manual:
>
>     * Newsticker: (newsticker).     A feed reader for Emacs.

That's great, but the point of my report is that there should be a
reference to it in the emacs manual, and that reference should be
alongside similar emacs packages (eg. gnus).

It's not intuitive to check outside of the emacs manual from inside
emacs. A user (ahem, me) discovers newsticker in emacs, and by habit
looks for it by instinctively typing C-h R. I can understand the
situation needs to be different for emacs-related packages that are not
bundled into emacs itself and aren't 'part of emacs', but for packages
that have become part of the default emacs distribution, the
documentation should be withing the emacs manual. IMO, that should be
the standard behavior for all similar packages.

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.

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





  reply	other threads:[~2020-04-29  4:18 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 [this message]
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
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=20200429041745.srdhgypy5v27e3mv@E15-2016.optimum.net \
    --to=boruch_baum@gmx.com \
    --cc=40773@debbugs.gnu.org \
    --cc=ulf.jasper@web.de \
    /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).