Repository navigation
docs/api: telField and vitePreloadTag examples contain literal \n and render as one line #4620
Description
Two entries in docs/api/v4.2.0.json store a literal backslash-n (\n, two characters) in extended.docs instead of real newlines:
| Function | Literal \n sequences |
|---|---|
telField |
12 |
vitePreloadTag |
2 |
The API generator passes extended.docs through as HTML, so each example renders as a single long line with visible \n text. On https://api.wheels.dev/v4-2-0/view-helpers/telfield/ the code example is one 677-character line.
These docs are generated from the framework's inline documentation annotations, so the likely source is how those two functions' doc examples are written (an escaped newline in the annotation) or how the JSON is built.
To do:
- Find the source annotation for
telFieldandvitePreloadTagand fix the newlines there, or fix the extraction if it escapes them. - Check the other versions' JSON for the same pattern.
- The committed
web/sites/api/src/content/docs/v4-2-0/...pages change at the next docs regeneration.
Found while investigating #4616, which is about long code lines overflowing the page; that fix contains the overflow but doesn't fix this content.
Activity
bpamiri commentedon Oct 19, 2026
Correction after tracing it:
telFieldis the real bug. Its source example,vendor/wheels/public/docs/reference/controller/telfield.txt, is a single 677-byte line containing 12 literal\nand 5 literal\t(backslash sequences), and no real newlines. The docs pipeline copies it faithfully. The bug is in the publisheddocs/api/v4.1.0.jsonandv4.2.0.json.vitePreloadTagis fine. Its two\nsit inside a quoted string showing the function's return value, and that page already renders on multiple lines. Decoding them would break the example, so it stays as is.The fix will decode the escapes in
telfield.txt, so future builds are right. It will also apply an erratum to the 4.1.0 and 4.2.0 docs, patching that one docs value and regenerating the single affectedview-helpers/telfield.mdpage per version.docs(api): render the telField example on multiple lines (#4622)