unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: larsi@gnus.org, 8900@debbugs.gnu.org
Subject: bug#8900: 24.0.50; please index mentioned coding systems in Emacs manual
Date: Sat, 02 Jul 2011 09:11:29 +0300	[thread overview]
Message-ID: <83iprlqkj2.fsf@gnu.org> (raw)
In-Reply-To: <FD0168B158204A93AF40524397E2334B@us.oracle.com>

> From: "Drew Adams" <drew.adams@oracle.com>
> Cc: <larsi@gnus.org>, <8900@debbugs.gnu.org>
> Date: Fri, 1 Jul 2011 14:00:01 -0700
> 
> You need detailed doc about *each* coding system before you will index *any* of
> them?

I never said that.  Some of them _are_ indexed: raw-text,
no-conversion, and emacs-internal.  That's because the manual says
something specific about them, unlike the others.

> > Having index entries about something that isn't described
> > is a Bad Thing.
> 
> "Described" is vague here, so it's hard to judge.

Not really.  The following is _not_ a description:

	  For example, the coding system @code{iso-latin-1} has
  variants @code{iso-latin-1-unix}, @code{iso-latin-1-dos} and
  @code{iso-latin-1-mac}.

This mentions iso-latin-1-*, but says nothing at all about them.  The
whole sentence is an explanation of the -dos, -unix, -mac variants of
each coding-system, and uses iso-latin-1-* as an example.  And there's
no other reference to iso-latin-1-* anywhere in the manual.

How hard is it to judge that these symbols are not documented in the
manual?  I say it's obvious.  A reader who wants to know something
about iso-latin-1 will not be wiser after reading this.

> I do indexing for a living.

Then I pity your readers.





  reply	other threads:[~2011-07-02  6:11 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-20 15:24 bug#8900: 24.0.50; please index mentioned coding systems in Emacs manual Drew Adams
2011-07-01 14:28 ` Lars Magne Ingebrigtsen
2011-07-01 15:00   ` Drew Adams
2011-07-01 15:39     ` Lars Magne Ingebrigtsen
2011-07-01 15:54       ` Drew Adams
2011-07-01 17:52         ` Eli Zaretskii
2011-07-01 18:17           ` Drew Adams
2011-07-01 19:49             ` Eli Zaretskii
2011-07-01 21:00               ` Drew Adams
2011-07-02  6:11                 ` Eli Zaretskii [this message]
2011-07-02 14:37                   ` Drew Adams
2011-07-02 15:27                     ` Eli Zaretskii
2011-07-01 17:45   ` Eli Zaretskii
2011-07-01 19:46     ` Eli Zaretskii
2011-07-02 12:38       ` Lars Magne 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=83iprlqkj2.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=8900@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=larsi@gnus.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).