Add some explanations for #[must_use] #50511
Merged
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
zackmdavis
reviewed
May 7, 2018
src/libcore/result.rs
Outdated
| @@ -251,7 +251,7 @@ use ops; | |||
| /// [`Ok`]: enum.Result.html#variant.Ok | |||
| /// [`Err`]: enum.Result.html#variant.Err | |||
| #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)] | |||
| #[must_use] | |||
| #[must_use = "this may be an error"] | |||
There was a problem hiding this comment.
I feel like this wording could be clearer (imagine a brand new user indignantly thinking, "You're the compiler; you should know whether it's a compilation error or not"), but I'm not sure what exact phrasing to suggest instead; "this Result may be an Err variant" may be too jargony.
pietroalbini
added
the
S-waiting-on-review
|
r=me pending travis |
|
@bors r+ rollup |
|
📌 Commit a72a080 has been approved by |
bors
added
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
May 9, 2018
…avus Add some explanations for #[must_use] `#[must_use]` can be given a string argument which is shown whilst warning for things. We should add a string argument to most of the user-exposed ones. I added these for everything but the operators, mostly because I'm not sure what to write there or if we need anything there.
bors
added a commit
that referenced
this pull request
May 9, 2018
Rollup of 11 pull requests Successful merges: - #49988 (Mention Result<!, E> in never docs.) - #50148 (turn `ManuallyDrop::new` into a constant function) - #50456 (Update the Cargo submodule) - #50460 (Make `String::new()` const) - #50464 (Remove some transmutes) - #50505 (Added regression function match value test) - #50511 (Add some explanations for #[must_use]) - #50525 (Optimize string handling in lit_token().) - #50527 (Cleanup a `use` in a raw_vec test) - #50539 (Add more logarithm constants) - #49523 (Update RELEASES.md for 1.26.0) Failed merges:
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.
#[must_use]can be given a string argument which is shown whilst warning for things.We should add a string argument to most of the user-exposed ones.
I added these for everything but the operators, mostly because I'm not sure what to write there or if we need anything there.
r? @imperio @QuietMisdreavus
(I consider this to be a docs/diagnostics issue)