Skip to content
Snippets Groups Projects
Commit c813459f authored by Sybille Peters's avatar Sybille Peters Committed by Christian Kuhn
Browse files

[DOCS] Fix formatting for lists in .rst

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

Resolves: #101715
Releases: main, 12.4, 11.5
Change-Id: I8dca5634ae3dcd7e702197cb72b43d79a05f3f5c
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80652


Reviewed-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: default avatarcore-ci <typo3@b13.com>
Tested-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
parent 3b4e6f58
Branches
Tags
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment