bpo-29913: fix documentation for compare_networks()

[s-sanjay]

updating the doc as discussed in issue 29913

[mention-bot]

@s-sanjay, thanks for your PR! By analyzing the history of the files in this pull request, we identified @ncoghlan, @serhiy-storchaka and @hynek to be potential reviewers.

[the-knights-who-say-ni]

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA. This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

[s-sanjay]

@zhangyangyu I opened a new PR to fix the doc.

[zhangyangyu]

We need to improve the documentation not docstring. You could edit Doc/library/ipaddress.rst. And deprecate means a .. deprecated:: 3.7 command in the doc. You could refer to other files. :-)

[s-sanjay]

@zhangyangyu ok 👍 I made the change in doc and dropped the change in documentation.

[zhangyangyu]

You could add your name to Misc/NEWS. :-) And have you signed the CLA?

[s-sanjay]

@zhangyangyu I did sign the CLA day before yesterday.

[zhangyangyu]

It'll take some time for the CLA to take effect @s-sanjay .
And sorry I made a mistake. I mean add your name to Misc/ACKS. This is a doc change and we don't need an entry in Misc/NEWS, sorry. :-(

[s-sanjay]

@zhangyangyu yes I was wondering why it needs to go into NEWS. I updated the commit.

[zhangyangyu]

Thanks @s-sanjay !

[s-sanjay]

@zhangyangyu thank you !