From 3b29913295010e538df9a692f4e59ece9ed362d8 Mon Sep 17 00:00:00 2001
From: 南浦月 <nanpuyue@gmail.com>
Date: Wed, 2 Sep 2020 21:08:09 +0800
Subject: add a note for Ipv4Addr::to_ipv6_compatible

---
 library/std/src/net/ip.rs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'library/std/src/net')

diff --git a/library/std/src/net/ip.rs b/library/std/src/net/ip.rs
index 341a112df71..5aff2b5bb78 100644
--- a/library/std/src/net/ip.rs
+++ b/library/std/src/net/ip.rs
@@ -745,6 +745,9 @@ impl Ipv4Addr {
     ///
     /// 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
-- 
cgit 1.4.1-3-g733a5