# Best practices on updating documentation?

2 messages from 2013-10-13 to 2013-10-13. Participants: brian m. carlson, John Keeping.
Thread: https://gitlist.dev/t/35135

## brian m. carlson, 2013-10-13 20:42

Subject: Best practices on updating documentation?
Message-ID: <20131013204240.GD865149@vauxhall.crustytoothpaste.net>
URL: https://gitlist.dev/e/20131013204240.GD865149%40vauxhall.crustytoothpaste.net

```
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, 2013-10-13 21:03

Subject: Re: Best practices on updating documentation?
Message-ID: <20131013210304.GN27238@serenity.lan>
URL: https://gitlist.dev/e/20131013210304.GN27238%40serenity.lan
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.

```