Repository navigation
docs(tasks): the lossless envelope's placeholders read as HTML on docs.rs - #31
Merged
adammharris merged 1 commit intoNov 9, 2026
Conversation
adammharris
deleted the
agent/backlog-file-lossless-envelope-placeholders-read-as-html
branch
November 9, 2026 20:03
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.
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.rswrites the envelope schema in its module doc as two lines indented by two spaces: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 docjob, so nothing catches this. The fix is small, which is why the task names it: a fenced block, or backticks.How it was verified
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.RUSTDOCFLAGS='-D warnings' cargo doc -p fig-core --no-depsfails with threeunclosed HTML tagerrors, at lines 35 and 36. These are the only warningscargo docprints for fig-core.prov checkreports nothing for the new task. Its one finding is in.config/prov.yaml, which this PR does not touch; it comes from theprov0.18.0 on PATH, which predatestype: payload.Found during a backlog sweep that ran clippy, tests and
cargo docacross the scope repos.