squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #81549 - est31:wording_fix, r=jonas-schievink

Browse source 
Misc ip documentation fixes
This commit is contained in:
Jonas Schievink 2021-01-31 16:36:47 +01:00 committed by GitHub
parent 991b31377c cddeb5e47b
commit 47a5312c30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
library/std/src/net/ip.rs
View file

@ -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 |
@ -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
///
@ -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
/// 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.
@ -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].
///