Repository navigation
docs(api): render the telField example on multiple lines - #4622
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
telFieldAPI example rendered as one long line with visible\ntext. Its source,vendor/wheels/public/docs/reference/controller/telfield.txt, was a single line holding literal\nand\tsequences (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.
docs/api/v4.1.0.jsonandv4.2.0.json, onlytelField's extended docs value changes; every other entry is identical.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\nappears inside a string that shows the function's output, which is intentional.Fixes #4620
Testing
telFieldexample renders as a 13-line, tab-indented block on both v4-2-0 and v4-1-0, with no visible\n.telField). Only the twotelfield.mdpages changed.vitePreloadTag's page is byte-identical and still renders multi-line.🤖 Generated with Claude Code