Fix docs for UdpSocket::send #671
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
spacekookie
reviewed
Jan 14, 2020
There was a problem hiding this comment.
I think this is a good example.
I've actually been thinking about this myself, because some of the udp module examples were a bit unpolished. It's propably a good approach to create a more complete example in the module docs, then have each function doc only highlight how that function is actually useful, instead of trying to do half in either examples.
k-nasa
reviewed
Jan 14, 2020
src/net/udp/mod.rs
Outdated
| /// | ||
| /// let mut buf = vec![0; 1024]; | ||
| /// let n = socket.recv(&mut buf).await?; |
There was a problem hiding this comment.
Why remove recv call?
Is this an example of the recv function?
There was a problem hiding this comment.
Good catch. It looks like I put the docs in the wrong spot. I'll correct that issue right now
|
- /// let mut buf = vec![0; 1024];
- /// let n = socket.recv(&mut buf).await?;
Why remove `recv` call?
Is this an example of the `recv` function?
If its not, it should be
|
Noah-Kennedy
commented
Jan 14, 2020
k-nasa
changed the title
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.
Minor change to alter documentation for
sendto no longer duplicate the documentation forsend_to.Fixes #652.