[rustdoc] When calculating docs percentage, ignore items marked allow(missing_docs)

[Lokathor]

Request

The --show-coverage unstable option should not count items marked as allow(missing_docs) when calculating the docs percentage.

Use Case

I have a crate full of "bitfield" types, where the useful data is bit packed into integers (example). Each pseudo-field has a getter and a setter. I would like to document the getters, but the setters simply match the associated getter, and additional words on them would only serve to distract.

Accordingly, the getters are marked as allow(missing_docs), and they shouldn't count towards the docs coverage.

[jyn514]

Mentoring instructions: Add a new argument should_have_docs: bool to fn count_item:

rust/src/librustdoc/passes/calculate_doc_coverage.rs

Line 39 in dadde88

fn count_item(

Then pass in whether the item has allow(missing_docs), which can be found from attrs:

rust/src/librustdoc/passes/calculate_doc_coverage.rs

Line 231 in dadde88

let has_docs = !i.attrs.doc_strings.is_empty();

[GuillaumeGomez]

It's not only should_have_docs: it shouldn't be counted as an item either.

[r-52]

@jyn514 / @Lokathor could I take a look at this one, please?

[GuillaumeGomez]

Go ahead.