Skip to content

Commit 2e1b045

Browse files
committed
docs(eval-render): note .TP-empty-tag → <p>&nbsp;</p> rendering quirk
Reviewers comparing diffs after the c3c42c7 mandoc fix see candidate pages render vertically taller; document why before someone files it as a regression.
1 parent 89d8f45 commit 2e1b045

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

tests/evals/render/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,13 @@ This is a review tool, not a golden snapshot test — it is intentionally not
119119
wired into `make tests-all`. Run it manually when changing
120120
`tools/mandoc-md`, `explainshell/web/markdown.py`, or the
121121
`clean_mandoc_artifacts`/`filter_sections` helpers.
122+
123+
## Known rendering quirks
124+
125+
`.TP \ ` (empty-tag tagged paragraph with `\ ` placeholder) renders as
126+
`<p>&nbsp;</p>` in HTML — a visible blank-line block. Earlier mandoc-md
127+
versions emitted these as `**** ` lines, which CommonMark folded into
128+
`<hr />` thematic breaks; the current binary preserves the authorial
129+
intent of an empty paragraph. The candidate page is therefore vertically
130+
taller than baseline at every such site, but no spurious horizontal rules
131+
appear. This is by design.

0 commit comments

Comments
 (0)