[PATCH v2 1/9] scalar: fix command documentation section header
- From
Victoria Dye via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Sep 2, 2022, 15:56 UTC
- Message-ID
- <614cbdc629ddb099f4a30ad6d217d1f1c716da83.1662134210.git.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.1341.v2.git.1662134210.gitgitgadget@gmail.com>
From: Victoria Dye <vdye@github.com>
Rename the last section header in 'contrib/scalar/scalar.txt' from "Scalar" to "GIT". The linting rules of the 'documentation' CI build enforce the existence of a "GIT" section in command documentation. Although 'scalar.txt' is not yet checked, it will be in a future patch.
Here, changing the header name is more appropriate than making a Scalar-specific exception to the linting rule. The existing "Scalar" section contains only a link back to the main Git documentation, essentially the same as the "GIT" section in builtin documentation. Changing the section name further clarifies the Scalar-Git association and maintains consistency with the rest of Git.
Signed-off-by: Victoria Dye <vdye@github.com> --- contrib/scalar/scalar.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/contrib/scalar/scalar.txt b/contrib/scalar/scalar.txt index 1a12dc45077..f33436c7f65 100644 --- a/contrib/scalar/scalar.txt +++ b/contrib/scalar/scalar.txt @@ -161,6 +161,6 @@ SEE ALSO -------- linkgit:git-clone[1], linkgit:git-maintenance[1]. -Scalar +GIT --- -Associated with the linkgit:git[1] suite +Part of the linkgit:git[1] suite
-- gitgitgadget