Repository navigation
fix(cli): keep the binary's pages out of the library's directory - #16
Merged
adammharris merged 1 commit intoNov 3, 2026
Merged
adammharris merged 1 commit into
adammharris merged 1 commit into
Conversation
The `plates` binary in plates-cli and the `plates` library both documented into `target/doc/plates/` (rust-lang/cargo#6313), so `cargo doc --workspace` left the binary's index where the library's belonged. The `[[bin]]` now says `doc = false`, and the Docs job fails on Cargo's `output filename collision`, which `RUSTDOCFLAGS='-D warnings'` does not reach. Closes docs/tasks/cargo-doc-writes-the-cli-over-the-library.md.
adammharris
deleted the
agent/backlog-fix-cargo-doc-writes-the-cli-over-the-library
branch
November 3, 2026 04:41
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
plates-cli/Cargo.toml: theplates[[bin]]getsdoc = false, socargo doc --workspacewrites only the library intotarget/doc/plates/..config/ship.figl: the Docs job pipescargo docthroughawkand fails on anyoutput filename collision.RUSTDOCFLAGS='-D warnings'catches rustdoc's warnings but not Cargo's, so until now a collision passed.status: donewith a status note, in place, as plates closes tasks.Why
The binary and the library are both named
plates, so both documented into one directory (rust-lang/cargo#6313), andtarget/doc/plates/index.htmlwas the binary's, listing none of the library's modules. Of the task's candidates this takes the first (doc = false) and the third (a guard in the job), the same as historica#19. The second, moving the CLI's modules into a library target with its own doc directory, is still open if the binary's private modules should be documented locally.Closes the task "cargo doc writes the CLI's pages over the library's" (
docs/tasks/cargo-doc-writes-the-cli-over-the-library.md).How it was verified
target/doc:ship ci docsfails on the collision warning.doc = false:ship ci docspasses with no collision, andtarget/doc/plates/holds the library's modules (collect,digest,error,links,mount,plan,source,spec,term,theme) and nofn.main.html.ship ci(all 7 jobs: fmt, clippy, test, docs, wasm, alone, msrv) passes.prov check: no findings.