git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Best practices on updating documentation?

From
John Keeping <john@keeping.me.uk>
Date
Oct 13, 2013, 21:03 UTC
Message-ID
<20131013210304.GN27238@serenity.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.

Previous: brian m. carlson
Message 2 of 2 in “Best practices on updating documentation?”
  1. brian m. carlsonOct 13, 2013
  2. John KeepingOct 13, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.