update documentation to deprecate compare_networks from 3.7

sanjay · sanjay · commit 159a4aea6f23 · 2017-03-27T23:46:23.000-07:00
diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst
@@ -554,6 +554,9 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
          >>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))
          0
 
+      .. deprecated:: 3.7
+         It uses the same ordering and comparison algorithm as "<", "==", and ">"
+
 
 .. class:: IPv6Network(address, strict=True)
 

Original file line number	Diff line number	Diff line change
@@ -554,6 +554,9 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
`554`	`554`	`>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))`
`555`	`555`	`0`
`556`	`556`
	`557`	`+ .. deprecated:: 3.7`
	`558`	`+ It uses the same ordering and comparison algorithm as "<", "==", and ">"`
	`559`	`+`
`557`	`560`
`558`	`561`	`.. class:: IPv6Network(address, strict=True)`
`559`	`562`