Fix a couple places in docs where try_send wasn't changed to send_opt #13610
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
| @@ -669,7 +669,7 @@ impl<T: Send> SyncSender<T> { | |||
|
|
|||
| /// Attempts to send a value on this channel without blocking. | |||
| /// | |||
| /// This method semantically differs from `Sender::try_send` because it can | |||
| /// This method semantically differs from `Sender::send_opt` because it can | |||
| /// fail if the receiver has not disconnected yet. If the buffer on this | |||
| /// channel is full, this function will immediately return the data back to | |||
| /// the callee. | |||
There was a problem hiding this comment.
Hm, this paragraph is a bit odd now that it's no longer talking about a neighboring function with the same name. Could you change the text to this?
This method differs from
send_optby returning immediately if the channel's buffer is full or no receiver is waiting to acquire some data. Compared withsend_opt, this function has two failure cases instead of one (one for disconnection, one for a full buffer).
There was a problem hiding this comment.
Yeah that bugged me too, but I wasn't sure what would be better. Changed it to use your text!
flip1995
pushed a commit
to flip1995/rust
that referenced
this pull request
Nov 7, 2024
Add test case for `missing_errors_doc` at tests with option `check-private-item=true` Add test case for `missing_errors_doc` at tests with option `check-private-item=true` to proof that rust-lang/rust-clippy#13391 is not an issue anymore changelog: none Closes: rust-lang/rust-clippy#13391
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.
I was getting a bit confused by these and (I think) managed to track it down to fallout from #13448 and #13465.