Skip to content

Commit

Permalink
scalar: fix command documentation section header
Browse files Browse the repository at this point in the history
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
vdye authored and gitster committed Sep 2, 2022
1 parent d42b38d commit b6faef3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contrib/scalar/scalar.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit b6faef3

Please sign in to comment.