rustdoc: skip #[allow(missing docs)] for docs in coverage report

[r-52]

During the document coverage reporting with:

rustdoc something.rs -Z unstable-options --show-coverage

the coverage report counts code that is marked with #[allow(missing_docs)] for the calculation, which outputs lower numbers in the coverage report even though these parts should be ignored for the calculation.

Right now I'm not sure how this can be tested (CI)? (I verified it by hand and ran the unit tests)

r? @jyn514

Reference: Fixes #76121

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @jyn514 (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

[jyn514]

Right now I'm not sure how this can be tested (CI)? (I verified it by hand and ran the unit tests)

You can test it by adding a file to src/test/rustdoc-ui/coverage/ that uses doc(hidden). Not sure how to generate the .stdout files, maybe run x.py test src/test/rustdoc-ui/coverage/ --bless?

[jyn514]

See also https://rustc-dev-guide.rust-lang.org/rustdoc.html#cheat-sheet and https://rustc-dev-guide.rust-lang.org/tests/adding.html#guide-to-the-ui-tests

[r-52]

See also https://rustc-dev-guide.rust-lang.org/rustdoc.html#cheat-sheet and https://rustc-dev-guide.rust-lang.org/tests/adding.html#guide-to-the-ui-tests

@jyn514 thanks for the help and the suggestions! I'll take a look and ping you when I'm done 👍

[ollie27]

#[allow(missing_docs)] also applies to inner items so I would expect it to do the same with --show-coverage. For example I would expect the following to print 100% coverage:

#![deny(missing_docs)]

//! crate docs

#[allow(missing_docs)]
pub mod foo {
    pub struct Foo;
}

[r-52]

@ollie27 thanks for the input! That was indeed a part that I missed, but it's covered now 👍

[crlf0710]

@r-52 Ping from triage, would you mind address the review comments above? thanks!

[r-52]

@crlf0710 hi, thanks the ping! Right now, I don't have the time to work on it. Feel free to pick it up

[GuillaumeGomez]

I'll finish it then.

[GuillaumeGomez]

Ok, updated!

[jyn514]

@bors r+

Looks great!

[bors]

📌 Commit 6854440 has been approved by jyn514

[bors]

⌛ Testing commit 6854440 with merge 4d63435...

[bors]

☀️ Test successful - checks-actions, checks-azure
Approved by: jyn514
Pushing 4d63435 to master...