all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Glenn Morris <rgm@gnu.org>
To: Xue Fuqiao <xfq.free@gmail.com>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: Re: changes in r112843
Date: Wed, 05 Jun 2013 13:41:05 -0400	[thread overview]
Message-ID: <r1ip1sa21a.fsf@fencepost.gnu.org> (raw)
In-Reply-To: <CAAF+z6HOwS2BU_LQV_o8+6ct0S1DLj7=in=KG0GO2g4WWGnsxQ@mail.gmail.com> (Xue Fuqiao's message of "Wed, 5 Jun 2013 07:12:24 +0800")


First, thank you for trying to improve the Emacs documentation.

My main point was, please don't copy text from other sources (especially
without attribution). Instead, it is much better to add a
cross-reference. This avoids duplication, and helps keep the size of the
manual down. (Or find your own phrasing. If you are not confident that
you have it correct, there are lots of people on this list who love
critiquing grammar etc.)

In this case, it would be something like: for more information on
branches, see <url:wikipedia/branches>. Which IMO shows how pointless it
is, because such a note could be added after just about every word in
the manual. It's obvious, and we don't need to state the obvious.

The Emacs manual does not need to explain why to use branches. It just
needs to say; if you _are_ using branches, here is how Emacs can help.
To avoid anyone reading the Emacs manual who doesn't know what a branch
is getting totally confused, there can optionally be a brief explanatory
sentence. That is what the original text had. Of course we could quibble
about the precise wording all day, but doing so won't improve the Emacs
manual measurably.



      parent reply	other threads:[~2013-06-05 17:41 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-04 17:40 changes in r112843 Glenn Morris
2013-06-04 22:59 ` Xue Fuqiao
2013-06-04 23:12   ` Xue Fuqiao
2013-06-05 10:46     ` Thien-Thi Nguyen
2013-06-05 23:13       ` Xue Fuqiao
2013-06-06 22:15         ` Thien-Thi Nguyen
2013-06-05 17:41     ` Glenn Morris [this message]

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=r1ip1sa21a.fsf@fencepost.gnu.org \
    --to=rgm@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=xfq.free@gmail.com \
    /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.