Review 12.4 Merged

80631[DOCS] Fix formatting for lists in .rst

Christian Kuhn CR +2 V +2 Easy +15 −14 updated 08/23/23, 07:43

Commit message

If there is not a newline before and after the list, the list
may not be formatted correctly.

A newline was added before and after lists in .rst files.

Additionally, some lines beginning with "- " (which would result
in false positives when checking) were modified so that list checking
can be performed more easily in the future.

Lists can be checked for example by using the following regular
expressions:

find typo3/sysext/*/Documentation -name "*.rst" | while read i;do
  grep -B1 -H -E "^(\-|\*)\s" "$i" | grep "\.rst-" \
    | grep -v -E "\.rst-($|\-|\*|\s)"
  grep -A1 -H -E "^(\-|\*)\s" "$i" | grep "\.rst-" \
    | grep -v -E "\.rst-($|\-|\*|\s)"
done

https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ \
WritingReST/CommonPitfalls/Lists.html

Review

  • Code review CR +2 Done
    • Christian Kuhn +2
  • Verified V +2 Done
    • Christian Kuhn +2

Issues 1

Files 7

Review log 34

  1. Christian Kuhn uploaded patch set 1 08/23/23, 07:25

  2. Christian Kuhn voted on patch set 1 V +2 CR +2 08/23/23, 07:27

  3. Christian Kuhn merged patch set 2 08/23/23, 07:27

  4. core-ci voted on patch set 1 V +1 08/23/23, 07:43 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/45734