Skip to content

Don't count variants/fields/consts/associated types in doc-coverage doc examples #75718

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.

Sign up for GitHub

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

Merged
bors merged 9 commits into from
Aug 22, 2020
Merged

Don't count variants/fields/consts/associated types in doc-coverage doc examples #75718

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3307ba8
Ignore code examples on given items where it doesn't make sense
GuillaumeGomez Aug 19, 2020
6fb7e02
Update rustdoc coverage UI test
GuillaumeGomez Aug 19, 2020
631c806
Remove "total" columns in --show-coverage output
GuillaumeGomez Aug 20, 2020
9c254c1
Update how doc examples are counted
GuillaumeGomez Aug 20, 2020
d108bd5
Add documentation for --show-coverage option
GuillaumeGomez Aug 20, 2020
5e9cc4e
fmt
GuillaumeGomez Aug 20, 2020
10a880d
Improve wording
GuillaumeGomez Aug 21, 2020
b20b6f8
Ignore more kind of items for doc examples
GuillaumeGomez Aug 21, 2020
adeedf5
Show line even if there is no code examples
GuillaumeGomez Aug 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fmt
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Aug 20, 2020
commit 5e9cc4e31920b72fe4f1c4a44d1a6e250e36f254
13 changes: 2 additions & 11 deletions src/librustdoc/passes/calculate_doc_coverage.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,7 @@ impl CoverageCalculator {
) {
println!(
"| {:<35} | {:>10} | {:>9.1}% | {:>10} | {:>9.1}% |",
name,
count.with_docs,
percentage,
count.with_examples,
examples_percentage,
name, count.with_docs, percentage, count.with_examples, examples_percentage,
);
}

Expand Down Expand Up @@ -247,12 +243,7 @@ impl fold::DocFolder for CoverageCalculator {
| clean::ConstantItem(_)
);
find_testable_code(
&i.attrs
.doc_strings
.iter()
.map(|d| d.as_str())
.collect::<Vec<_>>()
.join("\n"),
&i.attrs.doc_strings.iter().map(|d| d.as_str()).collect::<Vec<_>>().join("\n"),
&mut tests,
ErrorCodes::No,
false,
Expand Down