Skip to content

docs(tasks): the lossless envelope's placeholders read as HTML on docs.rs - #31

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

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

Conversation

@adammharris

Copy link
Copy Markdown
Member

Files a task for a defect in fig-core's published documentation. Nothing else changes: no code, and the task stays open for a fix on its own branch.

What

rust/fig-core/src/lossless.rs writes the envelope schema in its module doc as two lines indented by two spaces:

//!   { "$fig": { "t": "<type>" } }            // a null
//!   { "$fig": { "t": "<extkind>", "v": "<text>" } }   // an extended scalar

That indent doesn't make a code block, so rustdoc treats the lines as prose and passes <type>, <extkind> and <text> through as HTML tags. The docs.rs page for fig-core 7.0.0 (fig_core::lossless) holds them raw, so a browser shows the schema with every placeholder missing and the quotes curled. The next sentence then explains placeholders the reader cannot see.

Why it is worth a task

The envelope is the one place the lossless format is written down for a Rust caller, and fig-core is published to crates.io. fig's CI has no cargo doc job, so nothing catches this. The fix is small, which is why the task names it: a fenced block, or backticks.

How it was verified

  • docs.rs: fetched https://docs.rs/fig-core/7.0.0/fig_core/lossless/index.html; the page's HTML holds the bare <type>, <extkind> and <text> tags.
  • At d97b314, RUSTDOCFLAGS='-D warnings' cargo doc -p fig-core --no-deps fails with three unclosed HTML tag errors, at lines 35 and 36. These are the only warnings cargo doc prints for fig-core.
  • This change is documents only, so no build gate applies. prov check reports nothing for the new task. Its one finding is in .config/prov.yaml, which this PR does not touch; it comes from the prov 0.18.0 on PATH, which predates type: payload.

Found during a backlog sweep that ran clippy, tests and cargo doc across the scope repos.

@adammharris
adammharris merged commit 544b646 into main Nov 9, 2026
10 checks passed
@adammharris
adammharris deleted the agent/backlog-file-lossless-envelope-placeholders-read-as-html branch November 9, 2026 20:03
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