[Python-checkins] (no subject)

[Stéphane Wirtel]

To: python-checkins at python.org
Subject: Minor changes in Doc/faq/library. (#15449)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0

https://github.com/python/cpython/commit/88b24f96aedbe546d7d3248089d94e874edc=
0e11
commit: 88b24f96aedbe546d7d3248089d94e874edc0e11
branch: master
author: Antoine <43954001+awecx at users.noreply.github.com>
committer: St=C3=A9phane Wirtel <stephane at wirtel.be>
date: 2019-09-09T17:00:43+02:00
summary:

Minor changes in Doc/faq/library. (#15449)

* Minor changes.

* Update Doc/faq/library.rst

Co-Authored-By: Kyle Stanley <aeros167 at gmail.com>

* Apply suggestions from aeros167.

* Update Doc/faq/library.rst

Co-Authored-By: Kyle Stanley <aeros167 at gmail.com>

* Apply suggestions from aeros167 + re-add a "a" that was accidentally delete=
d.

files:
M Doc/faq/library.rst

diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index ab92a879a885..97058b5806a3 100644
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -125,7 +125,7 @@ argument list.  It is called as ::
=20
    handler(signum, frame)
=20
-so it should be declared with two arguments::
+so it should be declared with two parameters::
=20
    def handler(signum, frame):
        ...
@@ -159,9 +159,9 @@ The "global main logic" of your program may be as simple =
as ::
=20
 at the bottom of the main module of your program.
=20
-Once your program is organized as a tractable collection of functions and cl=
ass
-behaviours you should write test functions that exercise the behaviours.  A =
test
-suite that automates a sequence of tests can be associated with each module.
+Once your program is organized as a tractable collection of function and cla=
ss
+behaviours, you should write test functions that exercise the behaviours.  A
+test suite that automates a sequence of tests can be associated with each mo=
dule.
 This sounds like a lot of work, but since Python is so terse and flexible it=
's
 surprisingly easy.  You can make coding much more pleasant and fun by writing
 your test functions in parallel with the "production code", since this makes=
 it
@@ -295,7 +295,7 @@ queue as there are threads.
 How do I parcel out work among a bunch of worker threads?
 ---------------------------------------------------------
=20
-The easiest way is to use the new :mod:`concurrent.futures` module,
+The easiest way is to use the :mod:`concurrent.futures` module,
 especially the :mod:`~concurrent.futures.ThreadPoolExecutor` class.
=20
 Or, if you want fine control over the dispatching algorithm, you can write
@@ -679,7 +679,7 @@ How can I mimic CGI form submission (METHOD=3DPOST)?
 I would like to retrieve web pages that are the result of POSTing a form. Is
 there existing code that would let me do this easily?
=20
-Yes. Here's a simple example that uses urllib.request::
+Yes. Here's a simple example that uses :mod:`urllib.request`::
=20
    #!/usr/local/bin/python
=20
@@ -765,20 +765,21 @@ The :mod:`select` module is commonly used to help with =
asynchronous I/O on
 sockets.
=20
 To prevent the TCP connect from blocking, you can set the socket to non-bloc=
king
-mode.  Then when you do the ``connect()``, you will either connect immediate=
ly
+mode.  Then when you do the :meth:`socket.connect`, you will either connect =
immediately
 (unlikely) or get an exception that contains the error number as ``.errno``.
 ``errno.EINPROGRESS`` indicates that the connection is in progress, but hasn=
't
 finished yet.  Different OSes will return different values, so you're going =
to
 have to check what's returned on your system.
=20
-You can use the ``connect_ex()`` method to avoid creating an exception.  It =
will
-just return the errno value.  To poll, you can call ``connect_ex()`` again l=
ater
+You can use the :meth:`socket.connect_ex` method to avoid creating an except=
ion.  It will
+just return the errno value.  To poll, you can call :meth:`socket.connect_ex=
` again later
 -- ``0`` or ``errno.EISCONN`` indicate that you're connected -- or you can p=
ass this
-socket to select to check if it's writable.
+socket to :meth:`select.select` to check if it's writable.
=20
 .. note::
-   The :mod:`asyncore` module presents a framework-like approach to the prob=
lem
-   of writing non-blocking networking code.
+   The :mod:`asyncio` module provides a general purpose single-threaded and
+   concurrent asynchronous library, which can be used for writing non-blocki=
ng
+   network code.
    The third-party `Twisted <https://twistedmatrix.com/trac/>`_ library is
    a popular and feature-rich alternative.
=20
@@ -832,8 +833,8 @@ There are also many other specialized generators in this =
module, such as:
=20
 Some higher-level functions operate on sequences directly, such as:
=20
-* ``choice(S)`` chooses random element from a given sequence
-* ``shuffle(L)`` shuffles a list in-place, i.e. permutes it randomly
+* ``choice(S)`` chooses a random element from a given sequence.
+* ``shuffle(L)`` shuffles a list in-place, i.e. permutes it randomly.
=20
 There's also a ``Random`` class you can instantiate to create independent
 multiple random number generators.