add a note for Ipv4Addr::to_ipv6_compatible

2020-09-02 21:08:09 +08:00 · 2020-09-02 21:08:09 +08:00 · 3b29913295
commit 3b29913295
parent b4acb11033
1 changed files with 3 additions and 0 deletions
--- a/library/std/src/net/ip.rs
+++ b/library/std/src/net/ip.rs
@ -745,6 +745,9 @@ pub fn is_documentation(&self) -> bool {
    ///
    /// a.b.c.d becomes ::a.b.c.d
    ///
+    /// This isn't typically the method you want; these addresses don't typically
+    /// function on modern systems. Use `to_ipv6_mapped` instead.
+    ///
    /// [`IPv6` address]: Ipv6Addr
    ///
    /// # Examples