* Best practices on updating documentation?
@ 2013-10-13 20:42 brian m. carlson
2013-10-13 21:03 ` John Keeping
0 siblings, 1 reply; 2+ messages in thread
From: brian m. carlson @ 2013-10-13 20:42 UTC (permalink / raw)
To: git
[-- Attachment #1: Type: text/plain, Size: 344 bytes --]
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?
--
brian m. carlson / brian with sandals: Houston, Texas, US
+1 832 623 2791 | http://www.crustytoothpaste.net/~bmc | My opinion only
OpenPGP: RSA v4 4096b: 88AC E9B2 9196 305B A994 7552 F1BA 225C 0223 B187
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 836 bytes --]
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: Best practices on updating documentation?
2013-10-13 20:42 Best practices on updating documentation? brian m. carlson
@ 2013-10-13 21:03 ` John Keeping
0 siblings, 0 replies; 2+ messages in thread
From: John Keeping @ 2013-10-13 21:03 UTC (permalink / raw)
To: brian m. carlson; +Cc: git
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.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2013-10-13 21:03 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-10-13 20:42 Best practices on updating documentation? brian m. carlson
2013-10-13 21:03 ` John Keeping
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.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).