Do not emit missing_doc_code_examples rustdoc lint on module and a few other items
#133595
Conversation
This file contains hidden or 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
rustbot
added
S-waiting-on-review
|
Can we add some notes to the Rustdoc Book to document how we decide which things to require examples on and which ones to not? |
|
The section in the rustdoc book is a bit empty (to say the least). Gonna extend it and also include why some items don't have this "requirement". |
…the rustdoc book
|
Added a list of items which do not trigger the lint. |
|
Sweet. @bors r+ |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Dec 1, 2024
…amples, r=notriddle Do not emit `missing_doc_code_examples` rustdoc lint on module and a few other items It doesn't make sense to expect modules to have code examples. Same goes for: * Trait aliases * Foreign items * Associated types and constants Should make the use of this lint a bit nicer. r? `@notriddle`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#128004 (codegen `#[naked]` functions using global asm) - rust-lang#132974 (Properly pass linker arguments that contain commas) - rust-lang#133403 (Make `adjust_fulfillment_errors` work with `HostEffectPredicate` and `const_conditions`) - rust-lang#133482 (Only error raw lifetime followed by `\'` in edition 2021+) - rust-lang#133595 (Do not emit `missing_doc_code_examples` rustdoc lint on module and a few other items) - rust-lang#133669 (Move some functions out of const_swap feature gate) - rust-lang#133674 (Fix chaining `carrying_add`s) - rust-lang#133691 (Check let source before suggesting annotation) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2024
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#132974 (Properly pass linker arguments that contain commas) - rust-lang#133403 (Make `adjust_fulfillment_errors` work with `HostEffectPredicate` and `const_conditions`) - rust-lang#133482 (Only error raw lifetime followed by `\'` in edition 2021+) - rust-lang#133595 (Do not emit `missing_doc_code_examples` rustdoc lint on module and a few other items) - rust-lang#133669 (Move some functions out of const_swap feature gate) - rust-lang#133674 (Fix chaining `carrying_add`s) - rust-lang#133691 (Check let source before suggesting annotation) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2024
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#132974 (Properly pass linker arguments that contain commas) - rust-lang#133403 (Make `adjust_fulfillment_errors` work with `HostEffectPredicate` and `const_conditions`) - rust-lang#133482 (Only error raw lifetime followed by `\'` in edition 2021+) - rust-lang#133595 (Do not emit `missing_doc_code_examples` rustdoc lint on module and a few other items) - rust-lang#133669 (Move some functions out of const_swap feature gate) - rust-lang#133674 (Fix chaining `carrying_add`s) - rust-lang#133691 (Check let source before suggesting annotation) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2024
Rollup merge of rust-lang#133595 - GuillaumeGomez:missing_doc_code_examples, r=notriddle Do not emit `missing_doc_code_examples` rustdoc lint on module and a few other items It doesn't make sense to expect modules to have code examples. Same goes for: * Trait aliases * Foreign items * Associated types and constants Should make the use of this lint a bit nicer. r? ``@notriddle``
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
It doesn't make sense to expect modules to have code examples. Same goes for:
Should make the use of this lint a bit nicer.
r? @notriddle