-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
rustdoc: --show-coverage shouldn't count tuple struct fields #83255
Labels
A-doc-coverage
Area: Calculating how much of a crate has documentation
C-bug
Category: This is a bug.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
jonas-schievink
added
A-doc-coverage
Area: Calculating how much of a crate has documentation
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
labels
Mar 18, 2021
Tuple struct field docs will be rendered soon, assuming that #80320 merges. |
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this issue
Jul 27, 2021
…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc `@camelid` (since you were involved on the original PR). r? `@jyn514`
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this issue
Jul 28, 2021
…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc ``@camelid`` (since you were involved on the original PR). r? ``@jyn514``
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this issue
Jul 28, 2021
…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc ```@camelid``` (since you were involved on the original PR). r? ```@jyn514```
I guess we can now consider this issue to be fixed since #87451 was merged? |
@GuillaumeGomez that sounds right to me. Do you want to close it? |
Let's close it then. :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-doc-coverage
Area: Calculating how much of a crate has documentation
C-bug
Category: This is a bug.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
rustdoc's
--show-coverage
flag counts public fields of tuple structs, but this doesn't really make sense, sincedoc
attributes on such fields never appear in the generated documentation.For example, given the following in
src/lib.rs
:cargo rustdoc -- -Z unstable-options --show-coverage
reports:If
src/lib.rs
is changed to:then the coverage is reported as 100%, but, as expected, the documentation for the
pub u8
field isn't included in the documentation generated bycargo doc
.Meta
The text was updated successfully, but these errors were encountered: