Re: [PATCH v2] [Outreachy] commit.c: clarify comment describing commit re-parse behavior

From: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
Date: Oct 14, 2025, 00:41 UTC
Message-ID: <CAFpMFfCKimM9zWODGgEnA962C+i4nCBL41JcRcX48yqwY+jtcQ@mail.gmail.com>
In-Reply-To: <20251014003508.GD1507@coredump.intra.peff.net>

Thanks a lot for the feedback, Christian and Jeff! I’ll reword the commit message to use the imperative mood and add a short changelog with a link to the previous versions below the ‘---’ line.

On Tue, Oct 14, 2025 at 1:35 AM Jeff King <peff@peff.net> wrote:

Show 16 quoted lines

>
> On Sat, Oct 11, 2025 at 10:36:11AM +0100, Okhuomon Ajayi wrote:
>
> > 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