On 2024-02-16 22:45, Junio C Hamano wrote:
Dragan Simic <dsimic@xxxxxxxxxxx> writes:
But the halfway modification to the description section in this
patch is not an improvement. It makes some options described there
while -m and -c are completely missing now, making the section
incomplete and coverage of the operating modes of the command
uneven.
If I got it right, you'd prefer this patch not to be accepted
separately, but as part of the future series that would rework the
entire git-branch(1) man page? I'm fine with that as well.
Not necessarily. If you wanted to this this in multiple steps, we
can first whip the OPTIONS part into a good shape, and then fix the
DESCRIPTION part.
I'll think a bit more about it, to see what might be our best choice
moving forward.
What we want to avoid (not limited to this topic) is to say "this
temporarily makes things worse here, but trust me it will eventually
become perfect". Removing only -m/-c from the description section
makes the description section worse than before the patch---we'd be
better off leaving the original as-is if we are not revamping the
entire section.
The way you wrote this brought a smile to my face. :) I agree, making
things a bit worse while promising perfection later is rarely justified.
Perhaps only when some nasty bug has to be fixed ASAP.
