]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-checkout.txt
doc: git-checkout: reorganize examples
authorFelipe Contreras <felipe.contreras@gmail.com>
Tue, 18 Apr 2023 07:00:48 +0000 (01:00 -0600)
committerJunio C Hamano <gitster@pobox.com>
Tue, 18 Apr 2023 22:47:13 +0000 (15:47 -0700)
commit8dda6c3de21df2e2e8c09d860eae93e08cbc82a7
treedf38819e3c01e3617fcb485a690548817e37b745
parentf8bc75a55e877e3f3e71c36eae6e1ee8710e5a84
doc: git-checkout: reorganize examples

The examples are an ordered list, however, they are complex enough that
a callout is inside example 1, and that confuses the parsers as the list
continuation (`+`) is unclear (are we continuing the previous list item,
or the previous callout?).

We could use an open block as the asciidoctor documentation suggests,
but that has a tiny formatting issue (a newline is missing).

To simplify things for everyone (the reader, the writer, and the parser)
let's use subsections.

After this change, the HTML documentation generated with asciidoc has
the right indentation.

Cc: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-checkout.txt