Replace weird doc paragraph by compiler-checked must_use attribute #1801
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
|
I don't think it's necessary to remove the comment, especially without adding a reason to the Also, is there anywhere else in Axum that this footgun can occur? I was planning to search for it and open a PR of my own later today before finding this, but since you've got a PR already it's probably worth checking out. |
|
I found the paragraph I removed confusing. Otherwise I would not have removed it. Let's see what David thinks. Also, I don't intend to update the PR to cover more places that could use a |
davidpdrsn
reviewed
Mar 3, 2023
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
davidpdrsn
approved these changes
Mar 3, 2023
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.
Very lazy fix for making it harder to accidentally discard the
Responsegenerated byWebSocketUpgrade::on_upgrade. Feel free to improve by prodiving a message (#[must_use = "message"]or restoring a more useful version of the docs I deleted.