Repository navigation
docs(core): fence the lossless envelope schema in a code block - #32
Merged
adammharris merged 1 commit intoNov 11, 2026
Merged
Conversation
The two schema lines in fig_core::lossless's module doc were a two-space-indented paragraph, which Markdown reads as prose, so rustdoc passed <type>, <extkind> and <text> to the browser as HTML tags and docs.rs drew the schema with its placeholders missing. As a fenced text block they are escaped, and `RUSTDOCFLAGS='-D warnings' cargo doc -p fig-core --no-deps` passes. Closes docs/tasks/lossless-envelope-placeholders-read-as-html.md.
adammharris
deleted the
agent/backlog-lossless-envelope-placeholders-read-as-html
branch
November 11, 2026 02:55
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.
What changed
rust/fig-core/src/lossless.rs: the envelope schema in the module doc is now a fencedtextblock instead of a two-space-indented paragraph.docs/tasks/lossless-envelope-placeholders-read-as-html.mdis marked done.Why
Two spaces of indent is not a code block in Markdown, so the schema lines were prose. Rustdoc passed
<type>,<extkind>and<text>to the browser as HTML tags, so docs.rs showed the schema with its placeholders missing, andcargo docwarned three times. Inside a fence they are escaped.Closes
docs/tasks/lossless-envelope-placeholders-read-as-html.md.No behavioural change: only a doc comment changed.
How it was verified
RUSTDOCFLAGS='-D warnings' cargo doc -p fig-core --no-depsfailed with the task's threeunclosed HTML tagerrors. After it, the same command passes, and the generatedfig_core/lossless/index.htmlholds<type>,<extkind>and<text>.ship ci: all 11 jobs passed. Thetypescriptjob and the edit fixtures skipped, as they do withoutnode_modules. That does not matter here, since no code changed.