Skip to content

Commit cddeb5e

Browse files
committed
Misc ip documentation fixes
1 parent 202720b commit cddeb5e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

library/std/src/net/ip.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -1217,8 +1217,8 @@ impl Ipv6Addr {
12171217

12181218
/// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
12191219
///
1220-
/// A common mis-conception is to think that "unicast link-local addresses start with
1221-
/// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1220+
/// A common misconception is to think that "unicast link-local addresses start with
1221+
/// `fe80::`", but [IETF RFC 4291] actually defines a stricter format for these addresses:
12221222
///
12231223
/// ```no_rust
12241224
/// | 10 |
@@ -1228,9 +1228,9 @@ impl Ipv6Addr {
12281228
/// +----------+-------------------------+----------------------------+
12291229
/// ```
12301230
///
1231-
/// This method validates the format defined in the RFC and won't recognize the following
1232-
/// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1233-
/// If you need a less strict validation use [`Ipv6Addr::is_unicast_link_local()`] instead.
1231+
/// This method validates the format defined in the RFC and won't recognize addresses
1232+
/// like `fe80:0:0:1::` or `fe81::` as unicast link-local addresses.
1233+
/// If you need a less strict validation, use [`Ipv6Addr::is_unicast_link_local()`] instead.
12341234
///
12351235
/// # Examples
12361236
///
@@ -1282,7 +1282,7 @@ impl Ipv6Addr {
12821282
/// +----------+-------------------------+----------------------------+
12831283
/// ```
12841284
///
1285-
/// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1285+
/// As a result, this method considers addresses such as `fe80:0:0:1::` or `fe81::` to be
12861286
/// unicast link-local addresses, whereas [`Ipv6Addr::is_unicast_link_local_strict()`] does not.
12871287
/// If you need a strict validation fully compliant with the RFC, use
12881288
/// [`Ipv6Addr::is_unicast_link_local_strict()`] instead.
@@ -1362,7 +1362,7 @@ impl Ipv6Addr {
13621362
}
13631363

13641364
/// Returns [`true`] if this is an address reserved for documentation
1365-
/// (2001:db8::/32).
1365+
/// (`2001:db8::/32`).
13661366
///
13671367
/// This property is defined in [IETF RFC 3849].
13681368
///

0 commit comments

Comments
 (0)