[Python-Dev] cpython (2.7): Issue #15060: fix typo in socket doc; Patch by anatoly techtonik

[R. David Murray]

On Thu, 14 Jun 2012 16:15:41 +0200, Georg Brandl <g.brandl at gmx.net> wrote:
> Am 13.06.2012 23:59, schrieb sandro.tosi:
> > http://hg.python.org/cpython/rev/744fb52ffdf0
> > changeset:   77417:744fb52ffdf0
> > branch:      2.7
> > parent:      77408:60a7b704de5c
> > user:        Sandro Tosi <sandro.tosi at gmail.com>
> > date:        Wed Jun 13 23:58:35 2012 +0200
> > summary:
> >   Issue #15060: fix typo in socket doc; Patch by anatoly techtonik
> > 
> > files:
> >   Doc/library/socket.rst |  2 +-
> >   1 files changed, 1 insertions(+), 1 deletions(-)
> > 
> > 
> > diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
> > --- a/Doc/library/socket.rst
> > +++ b/Doc/library/socket.rst
> > @@ -38,7 +38,7 @@
> >  :const:`AF_UNIX` address family. A pair ``(host, port)`` is used for the
> >  :const:`AF_INET` address family, where *host* is a string representing either a
> >  hostname in Internet domain notation like ``'daring.cwi.nl'`` or an IPv4 address
> > -like ``'100.50.200.5'``, and *port* is an integral port number. For
> > +like ``'100.50.200.5'``, and *port* is an integer port number. For
> >  :const:`AF_INET6` address family, a four-tuple ``(host, port, flowinfo,
> >  scopeid)`` is used, where *flowinfo* and *scopeid* represents ``sin6_flowinfo``
> >  and ``sin6_scope_id`` member in :const:`struct sockaddr_in6` in C. For
> 
> I don't see the typo here, isn't "integral" the adjective form of "integer"?

We had a discussion about this on IRC, and I believe it has now been
further updated to "...*port* is an integer.".  To a native speaker's ear,
"integral port number" sounds wrong, probably because the port number
has to be an integer, so it sounds like saying "an integral integer".

The important thing the doc needs to convey is that the *port* argument
actually needs to be an *integer*, as opposed to a string.

--David