From: John Keeping <john@keeping.me.uk>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org
Subject: Re: Best practices on updating documentation?
Date: Sun, 13 Oct 2013 22:03:04 +0100 [thread overview]
Message-ID: <20131013210304.GN27238@serenity.lan> (raw)
In-Reply-To: <20131013204240.GD865149@vauxhall.crustytoothpaste.net>
On Sun, Oct 13, 2013 at 08:42:40PM +0000, brian m. carlson wrote:
> If I'm going to be adding an option to a command, should I update the
> documentation in the same commit or in a separate commit?
I would say the same commit, where it can help a reviewer see the code
change in the context of the expected user-facing behaviour.
prev parent reply other threads:[~2013-10-13 21:03 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-13 20:42 Best practices on updating documentation? brian m. carlson
2013-10-13 21:03 ` John Keeping [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=20131013210304.GN27238@serenity.lan \
--to=john@keeping.me.uk \
--cc=git@vger.kernel.org \
--cc=sandals@crustytoothpaste.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.
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 NNTP newsgroup(s).