Review main Merged

80600[DOCS] Fix formatting for lists in .rst

Sybille Peters CR +2 V +2 Easy +23 −14 updated 08/23/23, 07:27

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
    • Oliver Klee +1
    • Simon Schaufelberger +1
  • Verified V +2 Done
    • Christian Kuhn +2
    • Oliver Klee +1
    • Simon Schaufelberger +1
    • core-ci +1 CI

Issues 1

Files 9

Review log 911

  1. Sybille Peters uploaded patch set 1 08/20/23, 08:23

  2. core-ci voted on patch set 1 V +1 08/20/23, 08:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/45638

  3. Oliver Klee commented on patch set 1 CR +1 08/20/23, 08:37

    Thanks for taking care of this.
  4. Oliver Hader voted on patch set 1 CR +1 08/21/23, 07:14

  5. Oliver Hader voted on patch set 1 V +1 08/21/23, 07:15

  6. Sybille Peters uploaded patch set 2 CR +1 V +1 08/22/23, 18:59

  7. core-ci voted on patch set 2 V +1 08/22/23, 19:06 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/45694

  8. Oliver Klee voted on patch set 2 V +1 CR +1 08/22/23, 19:14

  9. Simon Schaufelberger voted on patch set 2 V +1 CR +1 08/23/23, 07:17

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

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