From: D. Ben Knoble <ben.knoble@gmail.com>
Date: Thu, 12 Feb 2026 22:22:05 GMT
Subject: Re: [PATCH v2] CodingGuidelines: document NEEDSWORK comments
Message-ID: <CALnO6CAjd0vbi0S+giYBwsyQwFmSZoWUBQMKiUEokCEeaNTnrQ@mail.gmail.com>
In-Reply-To: <xmqqldgxmzbj.fsf@gitster.g>

Small nit:

On Thu, Feb 12, 2026 at 4:23 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> We often say things like /* NEEDSWORK: further _do_ _this_ */ in
> comments, but it is a short-hand to say "We might later want to do
> this.  We might not.  We do not have to decide it right now at this
> moment in the commit this comment was added.  If somebody is
> inclined to work in this area further, the first thing they need to
> do is to figure out if it truly makes sense to do so, before blindly
> doing it.
>
> This seems to have never been documented.  Do so now.
>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>

The opening quote '"We might later…' doesn't appear to ever get closed.