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

Misc ip documentation fixes #81549

Merged
merged 1 commit into from
Feb 1, 2021
Merged

Misc ip documentation fixes #81549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions library/std/src/net/ip.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1217,8 +1217,8 @@ impl Ipv6Addr {

/// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
///
/// A common mis-conception is to think that "unicast link-local addresses start with
/// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
/// A common misconception is to think that "unicast link-local addresses start with
/// `fe80::`", but [IETF RFC 4291] actually defines a stricter format for these addresses:
///
/// ```no_rust
/// | 10 |
Expand All @@ -1228,9 +1228,9 @@ impl Ipv6Addr {
/// +----------+-------------------------+----------------------------+
/// ```
///
/// This method validates the format defined in the RFC and won't recognize the following
/// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
/// If you need a less strict validation use [`Ipv6Addr::is_unicast_link_local()`] instead.
/// This method validates the format defined in the RFC and won't recognize addresses
/// like `fe80:0:0:1::` or `fe81::` as unicast link-local addresses.
/// If you need a less strict validation, use [`Ipv6Addr::is_unicast_link_local()`] instead.
///
/// # Examples
///
Expand Down Expand Up @@ -1282,7 +1282,7 @@ impl Ipv6Addr {
/// +----------+-------------------------+----------------------------+
/// ```
///
/// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
/// As a result, this method considers addresses such as `fe80:0:0:1::` or `fe81::` to be
est31 marked this conversation as resolved.
Show resolved Hide resolved
/// unicast link-local addresses, whereas [`Ipv6Addr::is_unicast_link_local_strict()`] does not.
/// If you need a strict validation fully compliant with the RFC, use
/// [`Ipv6Addr::is_unicast_link_local_strict()`] instead.
Expand Down Expand Up @@ -1362,7 +1362,7 @@ impl Ipv6Addr {
}

/// Returns [`true`] if this is an address reserved for documentation
/// (2001:db8::/32).
/// (`2001:db8::/32`).
///
/// This property is defined in [IETF RFC 3849].
///
Expand Down