Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: clippy job is not failing on documentation errors #5739

Open
rcgoodfellow opened this issue May 11, 2024 · 1 comment
Open

CI: clippy job is not failing on documentation errors #5739

rcgoodfellow opened this issue May 11, 2024 · 1 comment

Comments

@rcgoodfellow
Copy link
Contributor

For example this error and many others like it are currently making it through CI.

warning: unresolved link to `StNestedBuilder::make_subsection`
   --> nexus/types/src/sectioned_table.rs:145:7
    |
145 | /// [`StNestedBuilder::make_subsection`].
    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `StNestedBuilder` in scope
    |
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
@iliana
Copy link
Contributor

iliana commented May 20, 2024

I figure what is missing in our clippy task is RUSTDOCFLAGS="-Dwarnings":

banner clippy
export CARGO_INCREMENTAL=0
ptime -m cargo xtask clippy
ptime -m cargo doc

But while trying to test that theory, I found I can't reproduce those messages locally running cargo doc. Not sure why.

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

No branches or pull requests

2 participants