Re: [PATCH 1/5] doc: git-rebase: start with an example

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 8, 2025, 18:11 UTC
Message-ID: <xmqqcy95hedv.fsf@gitster.g>
In-Reply-To: <f9cd981e-276b-4b13-8e98-c7bae17bcf62@app.fastmail.com>

"Julia Evans" <julia@jvns.ca> writes:

> I'm very happy to hear that feedback: I thought it was very dry as
> well, but I copied that part from elsewhere in the man page
> because I thought that was git's preferred documentation
> style. I'll work on making it less dry.

[administrivia: please wrap your overlong lines; we write for this hypothetiical reader on an 80-column terminal].

Show 6 quoted lines

>> Note that you lost the mention of `git rebase master topic` syntax
>> and the explanation that the form being a shorthand for checkout
>> followed by rebase, which I do not think appear anywhere else in the
>> document, so my suggested rewrite above resurrects it.
>
> That's actually in PATCH 3/5 of this series:...

Which I think is too late; both are quite commonly used and useful, so showing them upfront when the command line examples are first introduced would be more preferrable.

Thanks.