Skip to content

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

Merged
bors merged 1 commit into
rust-lang:masterfrom
joshtriplett:inaddr-any
Apr 17, 2021
Merged

Add documentation to help people find Ipv4Addr::UNSPECIFIED#84257
bors merged 1 commit into
rust-lang:masterfrom
joshtriplett:inaddr-any

Conversation

@joshtriplett

@joshtriplettjoshtriplett commented Apr 16, 2021

Copy link
Copy Markdown
Member

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

@rust-highfive

Copy link
Copy Markdown
Contributor

r? @joshtriplett

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

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

Copy link
Copy Markdown
MemberAuthor

r? @m-ou-se

@joshtriplettjoshtriplett changed the title Add documentation to help people find IpAddr::UNSPECIFIEDAdd documentation to help people find Ipv4Addr::UNSPECIFIEDApr 16, 2021
@m-ou-se

Copy link
Copy Markdown
Member

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

@joshtriplett

Copy link
Copy Markdown
MemberAuthor

@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
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Apr 16, 2021

Copy link
Copy Markdown
Collaborator

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

@borsbors 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:masterApr 17, 2021
@rustbotrustbot 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: 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

@joshtriplett@rust-highfive@m-ou-se@bors@rustbot