From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Eli Zaretskii <eliz@gnu.org>
Cc: spacibba@aol.com, Stephen Berman <stephen.berman@gmx.net>,
emacs-devel@gnu.org
Subject: Re: master 270ca8c: Fix internal-lisp-face-attributes to match face.
Date: Sun, 20 Oct 2019 14:28:22 -0400 [thread overview]
Message-ID: <jwvzhhvp9dt.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <83wocz4cxb.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 20 Oct 2019 19:08:48 +0300")
>> > * lisp/face-remap.el (internal-lisp-face-attributes): Updated the
>> ^^^^^^^
>> The conventional practice is to use the imperative form of verbs in
>> commit messages (so here "Update").
Indeed. The comment should describe what the change does rather than
what it did.
>> (I couldn't find documentation of this practice
It comes from the GNU Coding Standards
(https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs),
where it's not described in the text but can be seen in the example.
> Because there's nothing wrong with "Updated", IMO.
It's less consistent with the rest of our changelogs, and it wastes
a precious byte (and sometimes an even more precious column).
> You will find, for example, "Function removed" and the likes in
> the logs.
That's a passive form, and I prefer the active form.
This said, it's clearly much less important than the actual content of
the description.
Stefan
prev parent reply other threads:[~2019-10-20 18:28 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20191020144609.32634.23000@vcs0.savannah.gnu.org>
[not found] ` <20191020144611.3484F20BBC@vcs0.savannah.gnu.org>
2019-10-20 15:44 ` master 270ca8c: Fix internal-lisp-face-attributes to match face Stephen Berman
2019-10-20 16:08 ` Eli Zaretskii
2019-10-20 18:28 ` Stefan Monnier [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=jwvzhhvp9dt.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=spacibba@aol.com \
--cc=stephen.berman@gmx.net \
/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.