ci(tools): run rustdoc with --all-features#21427
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
There was a problem hiding this comment.
Pull request overview
Updates documentation generation commands to build Rust docs with all Cargo features enabled, ensuring doc comment errors in feature-gated code are caught (e.g., cases like #21425).
Changes:
- Add
--all-featuresto thejust docrecipe on both Unix and Windows. - Add
--all-featuresto the CI “Doc” job’scargo docinvocation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
justfile |
Ensures local just doc runs cargo doc with --all-features on Unix and Windows. |
.github/workflows/ci.yml |
Ensures CI documentation build covers all feature-gated code paths by using --all-features. |
|
No-one has objected, so merging... |
Merge activity
|
`just doc` run rustdoc with `--all-features` flag. I discovered that `just doc` was not, for example, catching errors in doc comments in #21425, because the code is behind a feature which is not enabled by default.
54ffc18 to
eb89608
Compare
just docrun rustdoc with--all-featuresflag.I discovered that
just docwas not, for example, catching errors in doc comments in #21425, because the code is behind a feature which is not enabled by default.