threads / discuss / 35135

Best practices on updating documentation?

Subject: Best practices on updating documentation?

## tl;dr

2 messages between Oct 13, 2013 and Oct 13, 2013.

replies: 1people: 2as markdown or json

brian m. carlson· Oct 13, 2013, 20:42 UTC · lore

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

John Keeping· Oct 13, 2013, 21:03 UTC · re: brian m. carlson · lore

Re: Best practices on updating documentation?

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.