Fixes to_s/to_string examples.

[fr3nch13]

The README says that the .to_s method outputs the canonical, but it only includes the address; however, to_string does include the CIDR. This fixes and clarifies the difference.

[fr3nch13]

IPv4

• to_s:

  ipaddress/lib/ipaddress/ipv4.rb

  Line 169 in 50a3d73

  @address

• to_string:

  ipaddress/lib/ipaddress/ipv4.rb

  Line 182 in 50a3d73

  "#@address/#@prefix"

IPv6

• to_s:

  • ipaddress/lib/ipaddress/ipv6.rb

    Line 204 in 50a3d73

    @compressed

  • ipaddress/lib/ipaddress/ipv6.rb

    Line 933 in 50a3d73

    "::ffff:#{@ipv4.address}"

• to_string:

  • ipaddress/lib/ipaddress/ipv6.rb

    Line 191 in 50a3d73

    "#@compressed/#@prefix"

  • ipaddress/lib/ipaddress/ipv6.rb

    Line 947 in 50a3d73

    "::ffff:#{@ipv4.address}/#@prefix"

[sandstrom]

I'm somewhat hesitant about this, because I'd prefer to deprecate to_string.

I think it's confusing that to_s and to_string exist, and return different things. I've never seen that in any other ruby library.

#132

[fr3nch13]

Are planning on replacing to_s with what to_string does now?

I know ruby/ipaddr does the same as your's currently does.

https://github.com/ruby/ipaddr/blob/master/lib/ipaddr.rb#230

[sandstrom]

Good point!

I didn't know. Are you aware of other libraries having both of these?

Are there any conventions on what the difference between them is 'supposed to be'?

I found this one, but it's about to_str.

https://marcgg.com/blog/2017/01/23/ruby-to-s-to-str/

[fr3nch13]

I haven't, but I'm also not a Ruby SR Dev. I'm sure others would have a more Ruby way opinion about how it should be done.

Maybe to_string should be called something else like to_cidr_notation or something (maybe shorter) like that?