On 28/06/2022 21:02, Derrick Stolee via GitGitGadget wrote:
From: Derrick Stolee <derrickstolee@xxxxxxxxxx> While inspecting the 'git rebase' documentation, I noticed that it is inconsistent with how it uses back-ticks (or other punctuation) for identifying Git commands, command-line arguments, or values for those arguments. Sometimes, an argument (like '--interactive') would appear without any punctuation, causing the argument to not have any special formatting. Other times, arguments or 'git rebase' itself would have single-quotes giving a bold look (in the HTML documentation at least). By consistently using back-ticks, these types of strings appear in a monospace font with special highlighting to appear more clearly as text that exists in a command-line invocation of a Git command. This rather-large diff is the result of scanning git-rebase.txt and adding back-ticks as appropriate. Some are adding back-ticks where there was no punctuation. Others are replacing single quotes. There are also a few minor cleanups in the process, including those found by reviwers.
Not worth a re-roll on its own: s/reviwers/reviewers/
Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx> Helped-by: Junio C Hamano <gitster@xxxxxxxxx> Signed-off-by: Derrick Stolee <derrickstolee@xxxxxxxxxx>
This is looking good, I've one minor comment below
-git rebase has two primary backends: apply and merge. (The apply -backend used to be known as the 'am' backend, but the name led to -confusion as it looks like a verb instead of a noun. Also, the merge +`git rebase` has two primary backends: 'apply' and 'merge'. (The 'apply' +backend used to be known as the `am` backend, but the name led to
I think we should keep single quotes around "am" as it is being used as a name like 'apply'
Thanks again for cleaning up the documentation Phillip
