From 208ec18292886a3eee2ff6c2f3929c3be91e558c Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 2 Apr 2025 14:08:18 -0400 Subject: [PATCH] Update README-documentation-rules.md Added notes about lists having to start a paragraph. --- docs/README-documentation-rules.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/README-documentation-rules.md b/docs/README-documentation-rules.md index 3151de7631..3659caf177 100644 --- a/docs/README-documentation-rules.md +++ b/docs/README-documentation-rules.md @@ -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 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.