unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stephen Leake <stephen_leake@stephe-leake.org>
To: emacs-devel@gnu.org
Subject: Re: Your commit 7409a79
Date: Wed, 10 Dec 2014 11:05:34 -0600	[thread overview]
Message-ID: <85wq5z5tb5.fsf@stephe-leake.org> (raw)
In-Reply-To: <E1XycZj-0004c1-9O@fencepost.gnu.org> (Richard Stallman's message of "Wed, 10 Dec 2014 03:24:47 -0500")

Richard Stallman <rms@gnu.org> writes:

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
>      >   Write documentation strings in the active voice, not the passive,
>      >   and in the present tense, not the future.  For instance, use
>      >    Return a list containing A and B.  instead of  A list containing A
>      >   and B will be returned. 
>
> Thanks.  I should probably move the advice from there into the GNU
> standards, since they are applicable to any manual.

This came up in a discussion of commit messages and Changelogs; would
you recommend active voice, present tense (not past), for those?

-- 
-- Stephe



  reply	other threads:[~2014-12-10 17:05 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-06  8:56 Your commit 7409a79 Eli Zaretskii
2014-12-06 10:22 ` Andreas Schwab
2014-12-06 10:29   ` Eli Zaretskii
2014-12-06 10:32   ` Paul Eggert
2014-12-06 15:29   ` Yuri Khan
2014-12-06 23:01   ` Stefan Monnier
2014-12-06 16:14 ` Tom
2014-12-06 18:54   ` Eli Zaretskii
2014-12-06 22:43   ` Stephen Leake
2014-12-06 22:33 ` Stephen Leake
2014-12-07  3:52   ` Eli Zaretskii
2014-12-07 22:39     ` Stephen Leake
2014-12-08  1:57       ` Paul Eggert
2014-12-08  2:28         ` Stephen J. Turnbull
2014-12-08 15:58           ` Eli Zaretskii
2014-12-08 23:38             ` Stephen Leake
2014-12-08 15:58         ` Eli Zaretskii
2014-12-08 18:24           ` Paul Eggert
2014-12-08 15:51       ` Eli Zaretskii
2014-12-08 17:32         ` John Yates
2014-12-08 17:57           ` Eli Zaretskii
2014-12-08 18:14             ` Paul Eggert
2014-12-08 18:28               ` Eli Zaretskii
2014-12-08 18:37               ` Eli Zaretskii
2014-12-08 18:54                 ` Paul Eggert
2014-12-08 19:00               ` Stefan Monnier
2014-12-08 18:54             ` John Yates
2014-12-08 23:27         ` Stephen Leake
2014-12-09  0:51           ` Thien-Thi Nguyen
2014-12-09  8:08             ` Stephen Leake
2014-12-09  9:36               ` Thien-Thi Nguyen
2014-12-09 16:57           ` Eli Zaretskii
2014-12-10  9:26             ` Stephen Leake
2014-12-10 16:17               ` Eli Zaretskii
2014-12-10 17:04                 ` Stephen Leake
2014-12-10 18:02                   ` Eli Zaretskii
2014-12-10 19:20                     ` Paul Eggert
2014-12-07  5:45   ` Stephen J. Turnbull
2014-12-06 22:59 ` Stefan Monnier
2014-12-07 22:44   ` Stephen Leake
2014-12-07 23:28     ` Stefan Monnier
2014-12-08  9:34       ` Stephen Leake
2014-12-08 10:22         ` Thien-Thi Nguyen
2014-12-08 14:58         ` Stefan Monnier
2014-12-08 23:32           ` Stephen Leake
2014-12-09 11:00           ` Richard Stallman
2014-12-09 11:09             ` David Kastrup
2014-12-10  8:24               ` Richard Stallman
2014-12-10 17:05                 ` Stephen Leake [this message]
2014-12-10 19:08                   ` Stefan Monnier
2014-12-08 15:54     ` Eli Zaretskii
2014-12-08 23:33       ` Stephen Leake

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=85wq5z5tb5.fsf@stephe-leake.org \
    --to=stephen_leake@stephe-leake.org \
    --cc=emacs-devel@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).