net: typo in IPNet.String documentation

[gaissmai]

What version of Go are you using (go version)?

$ go version
go version go1.12.7 linux/amd64

Does this issue reproduce with the latest release?

currently latest stable

What operating system and processor architecture are you using (go env)?

What did you do?

read the documentation

 go doc -src net.IPNet.String
// String returns the CIDR notation of n like "192.0.2.1/24"
// ...

What did you expect to see?

// String returns the CIDR notation of n like "192.0.2.0/24"

What did you see instead?

// String returns the CIDR notation of n like "192.0.2.1/24"

[agnivade]

It looks correct to me. 192.0.2.1 is the host IP, and /24 is the prefix. What is wrong here ?

[gaissmai]

Nope, the base IP address of 192.0.2.1/24 is 192.0.2.0, and the String() method use the base, see the test or the source:
https://play.golang.org/p/z05_nDz1EFP

[agnivade]

Oh that's right.

[odeke-em]

@clairerhoda perhaps you might be interested in this issue?

[bharaththiruveedula-zz]

@odeke-em @agnivade if no one is working on it ... can I push the PR?

[agnivade]

Up to you and @clairerhoda to figure out. I would suggest to wait for @clairerhoda to have a chance to respond.

[bharaththiruveedula-zz]

Sure. Will wait for @clairerhoda to decide.

[clairerhoda]

@odeke-em @agnivade if @bharaththiruveedula has it done he can open the PR.

[bharaththiruveedula-zz]

sure... then I will send PR