Skip to content

docs(core): fence the lossless envelope schema in a code block - #32

Merged
adammharris merged 1 commit into
mainfrom
agent/backlog-lossless-envelope-placeholders-read-as-html
Nov 11, 2026
Merged

adammharris merged 1 commit into
mainfrom
agent/backlog-lossless-envelope-placeholders-read-as-html

Conversation

@adammharris

Copy link
Copy Markdown
Member

What changed

  • rust/fig-core/src/lossless.rs: the envelope schema in the module doc is now a fenced text block instead of a two-space-indented paragraph.
  • docs/tasks/lossless-envelope-placeholders-read-as-html.md is 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, and cargo doc warned 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

  • Before the fix, RUSTDOCFLAGS='-D warnings' cargo doc -p fig-core --no-deps failed with the task's three unclosed HTML tag errors. After it, the same command passes, and the generated fig_core/lossless/index.html holds &lt;type&gt;, &lt;extkind&gt; and &lt;text&gt;.
  • ship ci: all 11 jobs passed. The typescript job and the edit fixtures skipped, as they do without node_modules. That does not matter here, since no code changed.
  • The docs.rs page updates with the next release.

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
adammharris merged commit 75fe491 into main Nov 11, 2026
10 checks passed
@adammharris
adammharris deleted the agent/backlog-lossless-envelope-placeholders-read-as-html branch November 11, 2026 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant