Skip to content

docs(api): render the telField example on multiple lines - #4622

Merged
bpamiri merged 1 commit into
developfrom
peter/telfield-example-newlines
Oct 19, 2026
Merged

bpamiri merged 1 commit into
developfrom
peter/telfield-example-newlines

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

The telField API example rendered as one long line with visible \n text. Its source, vendor/wheels/public/docs/reference/controller/telfield.txt, was a single line holding literal \n and \t sequences (12 and 5) instead of real newlines and tabs. The docs pipeline copies the file as written.

Source fix: the file now uses real newlines and tabs. The content and # characters are unchanged. Its only runtime reader, $getExtendedCodeExamples, outputs it as display text.

Erratum for the published docs: 4.1.0 and 4.2.0 carry the same example.

  • In docs/api/v4.1.0.json and v4.2.0.json, only telField's extended docs value changes; every other entry is identical.
  • The two generated pages, web/sites/api/src/content/docs/v4-{1,2}-0/view-helpers/telfield.md, are regenerated from it. Regenerating each version's whole tree otherwise reproduces the committed pages exactly.

Not changed: vitePreloadTag. Its \n appears inside a string that shows the function's output, which is intentional.

Fixes #4620

Testing

  • Built the API site. The telField example renders as a 13-line, tab-indented block on both v4-2-0 and v4-1-0, with no visible \n.
  • At 390px the page doesn't scroll sideways; the example scrolls inside its block (fix(web): contain wide code examples on API reference pages #4621).
  • Each JSON differs from develop in exactly one entry (telField). Only the two telfield.md pages changed.
  • vitePreloadTag's page is byte-identical and still renders multi-line.
  • No visual baseline change.

🤖 Generated with Claude Code

The telField example source, public/docs/reference/controller/telfield.txt,
was a single line holding literal backslash-n and backslash-t sequences
instead of real newlines and tabs. The docs pipeline copies it as written,
so the API page showed one long line with visible \n text. The file now
uses real newlines and tabs; the content is unchanged.

The published 4.1.0 and 4.2.0 API docs carry the same example, so their
JSON gets an erratum: only telField's extended docs value changes in each
version, and the two generated view-helpers/telfield.md pages are
regenerated from it. vitePreloadTag's \n is deliberate (it appears inside
a string showing the function's output) and is left alone.

Fixes #4620

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri
bpamiri merged commit a34d0dc into develop Oct 19, 2026
28 checks passed
@bpamiri
bpamiri deleted the peter/telfield-example-newlines branch October 19, 2026 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/api: telField and vitePreloadTag examples contain literal \n and render as one line

1 participant