Add documentation for the must_use attribute#157957
Merged
Merged
Conversation
rustbot
added
S-waiting-on-review
Collaborator
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @GuillaumeGomez (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
This comment has been minimized.
This comment has been minimized.
softfault
force-pushed
the
docs-must-use-attribute
branch
from
f817c7a to
9624b7f
Compare
| /// compiler warns through the [`unused_must_use`] lint. | ||
| /// | ||
| /// This is most common on types that represent an important state or outcome. For example, | ||
| /// [`Result`] is marked `#[must_use]` because ignoring an error value can hide a failed operation. |
Member
There was a problem hiding this comment.
Please add a code example illustrating this and also show the compiler message.
GuillaumeGomez
requested changes
Jun 16, 2026
rustbot
added
S-waiting-on-author
Collaborator
|
Reminder, once the PR becomes ready for a review, use |
Contributor
Author
:D |
softfault
force-pushed
the
docs-must-use-attribute
branch
from
9624b7f to
58870a5
Compare
Document the built-in `must_use` attribute in the standard library using the `#[doc(attribute = "...")]` mechanism, following the existing `keyword_docs.rs` pattern.
softfault
force-pushed
the
docs-must-use-attribute
branch
from
58870a5 to
72b3123
Compare
Contributor
|
As this is the first, and so will be a kind of template for later ones, @ehuss, I'm particularly interested to hear your thoughts here. |
Contributor
Author
|
@rustbot ready |
rustbot
added
S-waiting-on-review
GuillaumeGomez
approved these changes
Jun 17, 2026
Contributor
|
Seems fine to me. |
Member
|
Then let's go! @bors r=GuillaumeGomez,ehuss rollup |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
rust-bors Bot
pushed a commit
that referenced
this pull request
Jun 17, 2026
…uwer Rollup of 6 pull requests Successful merges: - #157816 (make more slice mutable ref getters rustc_no_writable) - #156788 (Document that destructors in running threads are not run on program exit) - #157957 (Add documentation for the `must_use` attribute) - #158006 (Simplify `HardwiredLints` and `SoftLints`) - #158007 (Pin dependencies) - #158025 (Enable `symbol_intern_string_literal` lint for rustdoc)
traviscross
approved these changes
Jun 17, 2026
Contributor
|
@bors r=GuillaumeGomez,ehuss,traviscross rollup |
Contributor
rust-timer
added a commit
that referenced
this pull request
Jun 17, 2026
Rollup merge of #157957 - softfault:docs-must-use-attribute, r=GuillaumeGomez,ehuss Add documentation for the `must_use` attribute Document the built-in `must_use` attribute in the standard library using the `#[doc(attribute = "...")]` mechanism, following the existing `keyword_docs.rs` pattern. Part of #157604. r? @GuillaumeGomez Tested with `./x test library/std --doc`.
82 tasks
pull Bot
pushed a commit
to xtqqczze/rust-lang-miri
that referenced
this pull request
Jun 18, 2026
…uwer Rollup of 6 pull requests Successful merges: - rust-lang/rust#157816 (make more slice mutable ref getters rustc_no_writable) - rust-lang/rust#156788 (Document that destructors in running threads are not run on program exit) - rust-lang/rust#157957 (Add documentation for the `must_use` attribute) - rust-lang/rust#158006 (Simplify `HardwiredLints` and `SoftLints`) - rust-lang/rust#158007 (Pin dependencies) - rust-lang/rust#158025 (Enable `symbol_intern_string_literal` lint for rustdoc)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Document the built-in
must_useattribute in the standard library using the#[doc(attribute = "...")]mechanism, following the existingkeyword_docs.rspattern.Part of #157604.
r? @GuillaumeGomez
Tested with
./x test library/std --doc.