Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

std::net::UdpSocket documentation about returned data is misleading #24925

Closed
frewsxcv opened this issue Apr 29, 2015 · 0 comments · Fixed by #24961
Closed

std::net::UdpSocket documentation about returned data is misleading #24925

frewsxcv opened this issue Apr 29, 2015 · 0 comments · Fixed by #24961

Comments

@frewsxcv
Copy link
Member

rust/src/libstd/net/udp.rs

Lines 67 to 68 in c4b23ae

/// Sends data on the socket to the given address. Returns nothing on
/// success.

Returns nothing on success.

Considering the return type is Result<usize, Error>, it doesn't seem like 'nothing' is an option
nham pushed a commit to nham/rust that referenced this issue Apr 29, 2015
Improve libstd/net/udp.rs documentation.
42196ae 
This adds some missing punctuation, adds a missing word, and
corrects a bug in the description of `send_to`, which actually
returns the number of bytes written on success.

Fixes rust-lang#24925.
@nham nham mentioned this issue Apr 29, 2015
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Apr 29, 2015
@alexcrichton
rollup merge of rust-lang#24961: nham/net_docs_cleanup
bc4b193 
Changes made include adding missing punctuation, adding missing words, and converting uses of "Gets" to "Returns" in libstd/net/addr.rs to make it more consistent with the other documentation.

Fixes rust-lang#24925.
steveklabnik pushed a commit to steveklabnik/rust that referenced this issue May 10, 2015
@steveklabnik
Improve libstd/net/udp.rs documentation.
97e0803 
This adds some missing punctuation, adds a missing word, and
corrects a bug in the description of `send_to`, which actually
returns the number of bytes written on success.

Fixes rust-lang#24925.
@durka durka mentioned this issue Aug 29, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

std::net documentation cleanup nham/rust
2 participants
@alexcrichton @frewsxcv