mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-11-03 09:14:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README-documentation-rules.md

Browse Source 
Added notes about lists having to start a paragraph.
This commit is contained in:
Ryan C. Gordon
2025-04-02 14:08:18 -04:00
committed by GitHub
parent 5709466ddd
commit 208ec18292
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/README-documentation-rules.md
View File

@@ -156,6 +156,23 @@ wikiheaders will wordwrap header comments so they fit in 80 columns, so if you
don't leave a blank line between paragraphs, they will smush into a single don't leave a blank line between paragraphs, they will smush into a single
block of text when wordwrapping. block of text when wordwrapping.
## Lists must be the start of a new paragraph.
If you write this:
```
Here is some text without a blank line
before an unordered list!
- item a
- item b
- item c
```
...then wikiheaders will word wrap this as a single paragraph, mangling the list.
Put a blank line before the list, and everything will format and wrap correctly.
This is a limitation of wikiheaders. Don't get bit by it!
## Don't worry about word wrapping. ## Don't worry about word wrapping.