Re: [PATCH v2] [Outreachy] commit.c: clarify comment describing commit re-parse behavior
- From
Jeff King <peff@peff.net>
- Date
- Oct 14, 2025, 00:35 UTC
- Message-ID
- <20251014003508.GD1507@coredump.intra.peff.net>
- In-Reply-To
- <20251011093611.62937-1-okhuomonajayi54@gmail.com>
On Sat, Oct 11, 2025 at 10:36:11AM +0100, Okhuomon Ajayi wrote:
Show 8 quoted lines
> The existing comment in `parse_commit_buffer()` mentioned a "leftover > from an earlier failed parse", which could be confusing to new readers. > It implied an error state rather than the intended cleanup before > re-parsing a commit. > > Clarifying the comment makes it explicit that we reset the parent list > to ensure a clean state before re-parsing, which improves readability > and avoids misunderstanding during future maintenance.
As the original author of this comment, I think what you've written retains the intent but is easier to understand. So looks good to me.
-Peff