all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 40011@debbugs.gnu.org, rms@gnu.org
Subject: bug#40011: Remove unnecessary abbreviations from documentation
Date: Mon, 27 Apr 2020 17:39:09 +0300	[thread overview]
Message-ID: <83wo613sdu.fsf@gnu.org> (raw)
In-Reply-To: <878siha2fl.fsf@stefankangas.se> (message from Stefan Kangas on Mon, 27 Apr 2020 08:05:34 +0200)

> From: Stefan Kangas <stefan@marxist.se>
> Cc: 40011@debbugs.gnu.org,  rms@gnu.org
> Date: Mon, 27 Apr 2020 08:05:34 +0200
> 
> > Let's not be too extreme: I'm against removing "e.g." and "i.e." at
> > the least.
> 
> There are many such instances to get right, so maybe we can find a way
> forward which avoids changing all of them.
> 
> How about adding something along the lines of the attached patch, and
> leave it at that?  Would that be acceptable?
>  [...]
> +@item
> +Avoid abbreviations like ``e.g.'' (for ``for example''), ``i.e.'' (for
> +``that is''), ``no.'' (for ``number''), ``c.f.'' (for ``in contrast
> +to'') and ``w.r.t.'' (for ``with respect to'').  It is almost always
> +both more clear and easier to read the expanded version.

It would be fine with me, but there are a lot of pedants out there,
and I'd rather we avoided bug reports telling us "why don't you do as
you say and remove all the e.g.'s from your own manuals."  I'd like to
avoid the endless disputes such bug reports tend to cause.

So could you make the above even less definitive, either by saying

  "Try to avoid using abbreviations like ... as much as possible."

Maybe even add a footnote saying something like "We do occasionally
use these, but try not to overdo it.".

OK?





  reply	other threads:[~2020-04-27 14:39 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-10 13:54 bug#40011: Remove unnecessary abbreviations from documentation Stefan Kangas
2020-03-10 14:49 ` Eli Zaretskii
2020-04-27  6:05   ` Stefan Kangas
2020-04-27 14:39     ` Eli Zaretskii [this message]
2020-04-27 17:08       ` Stefan Kangas
2020-04-27 18:30         ` Eli Zaretskii
2020-04-30 16:05           ` Stefan Kangas
2020-04-28  2:46       ` Richard Stallman
2020-04-27 16:08     ` Drew Adams
2020-04-27 16:21       ` Stefan Kangas
2020-04-27 16:41         ` Drew Adams
2020-04-28  2:49     ` Richard Stallman

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=83wo613sdu.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=40011@debbugs.gnu.org \
    --cc=rms@gnu.org \
    --cc=stefan@marxist.se \
    /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.