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

Add examples to UnixDatagram #2686

Closed
Darksonn opened this issue Jul 24, 2020 · 2 comments · Fixed by #2765
Closed

Add examples to UnixDatagram #2686

Darksonn opened this issue Jul 24, 2020 · 2 comments · Fixed by #2765
Labels
A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-net Module: tokio/net T-docs Topic: documentation

Comments

@Darksonn
Copy link
Contributor

Both to the type itself and its methods.

go to UnixDatagram docs
@Darksonn Darksonn added T-docs Topic: documentation C-maintenance Category: PRs that clean code up or issues documenting cleanup. A-tokio Area: The main tokio crate M-net Module: tokio/net E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. labels Jul 24, 2020
@caranatar
Copy link
Contributor

I'm going to try to do this tonight/tomorrow. This will be my first contribution, is the level of example in the std equivalent about what you're looking for? https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html

@Darksonn
Copy link
Contributor Author

That is indeed the level of documentation I want to eventually reach, although PRs that only get part of the way are also appreciated. Check also TcpStream for inspiration.

@caranatar caranatar mentioned this issue Aug 12, 2020
Merged
Darksonn pushed a commit that referenced this issue Aug 23, 2020
@caranatar
net: Add examples to UnixDatagram (#2765)
fde72bf 
* net: adding examples for UnixDatagram

Adding examples to documentation for UnixDatagram

* net: document named UnixDatagrams persistence

Add documentation to indicate that named UnixDatagrams 'leak'
socket files after execution.

* net: rustfmt issue in UnixDatagram

Fixing rustfmt issue in UnixDatagram

* net: adding examples for UnixDatagram

Fixes: #2686
Refs: #1679
Refs: #1111
@Darksonn Darksonn removed E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. labels Sep 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-net Module: tokio/net T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

net: Add examples to UnixDatagram (#2686)
2 participants
@Darksonn @caranatar