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.

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

Add documentation to help people find Ipv4Addr::UNSPECIFIED #84257

Merged
merged 1 commit into from
Apr 17, 2021

Conversation

joshtriplett
Copy link
Member

@joshtriplett joshtriplett commented Apr 16, 2021

People looking for INADDR_ANY don't always find Ipv4Addr::UNSPECIFIED;
add some documentation to help.

@rust-highfive
Copy link
Collaborator

r? @joshtriplett

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 16, 2021
@joshtriplett
Copy link
Member Author

r? @m-ou-se

@joshtriplett joshtriplett changed the title Add documentation to help people find IpAddr::UNSPECIFIED Add documentation to help people find Ipv4Addr::UNSPECIFIED Apr 16, 2021
@m-ou-se
Copy link
Member

m-ou-se commented Apr 16, 2021

Looks like a good use case for #[doc(alias = ..)].

@joshtriplett
Copy link
Member Author

@m-ou-se I'd be happy to add that as well, I just knew we were still discussing when that was appropriate to use. If you think it's fine in this case, I'll add it.

People looking for `INADDR_ANY` don't always find
`Ipv4Addr::UNSPECIFIED`; add some documentation and an alias to help.
@m-ou-se
Copy link
Member

m-ou-se commented Apr 16, 2021

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 16, 2021

📌 Commit 9aa4d06 has been approved by m-ou-se

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 16, 2021
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Apr 17, 2021
Add documentation to help people find `Ipv4Addr::UNSPECIFIED`

People looking for `INADDR_ANY` don't always find `Ipv4Addr::UNSPECIFIED`;
add some documentation to help.
This was referenced Apr 17, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 17, 2021
Rollup of 4 pull requests

Successful merges:

 - rust-lang#83237 (rustdoc: use more precise relative URLs)
 - rust-lang#84150 (rustdoc: move some search code into search.js)
 - rust-lang#84203 (rustdoc: Give a more accurate span for anchor failures)
 - rust-lang#84257 (Add documentation to help people find `Ipv4Addr::UNSPECIFIED`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit a3277e2 into rust-lang:master Apr 17, 2021
@rustbot rustbot added this to the 1.53.0 milestone Apr 17, 2021
@joshtriplett joshtriplett deleted the inaddr-any branch April 17, 2021 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants