Use missing_docs lint on tuple fields as well #88688
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GuillaumeGomez
added
T-rustdoc
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
missing-docs-tuple-fields
branch
from
4bf2145 to
a13426c
Compare
GuillaumeGomez
force-pushed
the
missing-docs-tuple-fields
branch
from
a13426c to
d6f07f8
Compare
|
This is not a rustdoc change, you need to talk to @rust-lang/lang. |
jyn514
added
T-lang
|
I'm against this change, documenting tuple variant fids is not something that is in the general norm of rust. This lint would create a ton of warnings across projects that would most likely silence it. It's actually worth considering if rustdoc coverage should be counting tuple field docs , to me this is similar to documenting private stuff: good to do, but not expected. (Lints are typically a compiler team thing fwiw) |
|
Perfect, to be honest I wasn't super happy about this change, I rather change how we count in the |
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Sep 10, 2021
…lds-count, r=Manishearth Rustdoc coverage fields count Follow-up of rust-lang#88688. Instead of requiring enum tuple variant fields and tuple struct fields to be documented, we count them if they are documented, otherwise we don't include them in the count. r? `@Manishearth`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since we count them in the rustdoc
show-coverageoption, I thought it would be logical to throw the error here as well.What do you think @rust-lang/rustdoc ?
r? @Manishearth