]> granicus.if.org Git - python/commitdiff
Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation...
authorSenthil Kumaran <senthil@uthcode.com>
Mon, 15 Jun 2015 00:35:37 +0000 (17:35 -0700)
committerSenthil Kumaran <senthil@uthcode.com>
Mon, 15 Jun 2015 00:35:37 +0000 (17:35 -0700)
Related Issues:

#issue21528
#issue24453

28 files changed:
Doc/distutils/apiref.rst
Doc/distutils/builtdist.rst
Doc/howto/clinic.rst
Doc/howto/regex.rst
Doc/howto/sockets.rst
Doc/library/argparse.rst
Doc/library/cmd.rst
Doc/library/collections.abc.rst
Doc/library/collections.rst
Doc/library/configparser.rst
Doc/library/http.server.rst
Doc/library/ipaddress.rst
Doc/library/logging.handlers.rst
Doc/library/plistlib.rst
Doc/library/resource.rst
Doc/library/select.rst
Doc/library/shutil.rst
Doc/library/site.rst
Doc/library/socket.rst
Doc/library/threading.rst
Doc/library/tkinter.ttk.rst
Doc/library/tracemalloc.rst
Doc/library/turtle.rst
Doc/library/urllib.request.rst
Doc/library/weakref.rst
Doc/library/xml.dom.rst
Doc/whatsnew/2.1.rst
Doc/whatsnew/3.3.rst

index 82bed24983639c3fe337f2f1a7bc79de39d44b73..53d7527c657e30ca329d952950d289ed8ed939e4 100644 (file)
@@ -1099,13 +1099,13 @@ other utility module.
    during the build of Python), not the OS version of the current system.
 
    For universal binary builds on Mac OS X the architecture value reflects
-   the univeral binary status instead of the architecture of the current
+   the universal binary status instead of the architecture of the current
    processor. For 32-bit universal binaries the architecture is ``fat``,
    for 64-bit universal binaries the architecture is ``fat64``, and
    for 4-way universal binaries the architecture is ``universal``. Starting
    from Python 2.7 and Python 3.2 the architecture ``fat3`` is used for
    a 3-way universal build (ppc, i386, x86_64) and ``intel`` is used for
-   a univeral build with the i386 and x86_64 architectures
+   a universal build with the i386 and x86_64 architectures
 
    Examples of returned values on Mac OS X:
 
index ac96c4030022add64b0ca80f9b128ddc45ed0955..c5827b63cf9c1100effe4db885f9877586e62539 100644 (file)
@@ -355,7 +355,7 @@ support this option, so the command::
 would create a 64bit installation executable on your 32bit version of Windows.
 
 To cross-compile, you must download the Python source code and cross-compile
-Python itself for the platform you are targetting - it is not possible from a
+Python itself for the platform you are targeting - it is not possible from a
 binary installation of Python (as the .lib etc file for other platforms are
 not included.)  In practice, this means the user of a 32 bit operating
 system will need to use Visual Studio 2008 to open the
index 0b7cadad48b7a3f28f02bb0e53b9995edfa1df50..e362631db6af614ef8ad0cfe6786bb52e5c25e83 100644 (file)
@@ -886,7 +886,7 @@ Argument Clinic generates code that does it for you (in the parsing function).
 Advanced converters
 -------------------
 
-Remeber those format units you skipped for your first
+Remember those format units you skipped for your first
 time because they were advanced?  Here's how to handle those too.
 
 The trick is, all those format units take arguments--either
@@ -1020,12 +1020,12 @@ any of the default arguments you can omit the parentheses.
 the ``"as"`` should come before the return converter.)
 
 There's one additional complication when using return converters: how do you
-indicate an error has occured?  Normally, a function returns a valid (non-``NULL``)
+indicate an error has occurred?  Normally, a function returns a valid (non-``NULL``)
 pointer for success, and ``NULL`` for failure.  But if you use an integer return converter,
 all integers are valid.  How can Argument Clinic detect an error?  Its solution: each return
 converter implicitly looks for a special value that indicates an error.  If you return
 that value, and an error has been set (``PyErr_Occurred()`` returns a true
-value), then the generated code will propogate the error.  Otherwise it will
+value), then the generated code will propagate the error.  Otherwise it will
 encode the value you return like normal.
 
 Currently Argument Clinic supports only a few return converters::
@@ -1573,7 +1573,7 @@ The fourth new directive is ``set``::
 ``line_prefix`` is a string that will be prepended to every line of Clinic's output;
 ``line_suffix`` is a string that will be appended to every line of Clinic's output.
 
-Both of these suport two format strings:
+Both of these support two format strings:
 
   ``{block comment start}``
     Turns into the string ``/*``, the start-comment text sequence for C files.
index fbe763b3f2a33ef01e03b825ac3ca315f9a2183c..9ae04d718d8cfa07ff6b34b29f4c857cf05411ec 100644 (file)
@@ -852,7 +852,7 @@ keep track of the group numbers.  There are two features which help with this
 problem.  Both of them use a common syntax for regular expression extensions, so
 we'll look at that first.
 
-Perl 5 is well-known for its powerful additions to standard regular expressions.
+Perl 5 is well known for its powerful additions to standard regular expressions.
 For these new features the Perl developers couldn't choose new single-keystroke metacharacters
 or new special sequences beginning with ``\`` without making Perl's regular
 expressions confusingly different from standard REs.  If they chose ``&`` as a
index d5aff9081d232e89d214ebf37db915af3bccc469..04394d49f01977594a664d5ca9d27740d73fbd73 100644 (file)
@@ -234,7 +234,7 @@ messages to be sent back to back (without some kind of reply), and you pass
 following message. You'll need to put that aside and hold onto it, until it's
 needed.
 
-Prefixing the message with it's length (say, as 5 numeric characters) gets more
+Prefixing the message with its length (say, as 5 numeric characters) gets more
 complex, because (believe it or not), you may not get all 5 characters in one
 ``recv``. In playing around, you'll get away with it; but in high network loads,
 your code will very quickly break unless you use two ``recv`` loops - the first
index ebf88fad54bb81f7275b6925c4dfe2fd0253627b..067fb8f748803b57875cf4ff246081adbaaa11bd 100644 (file)
@@ -1910,7 +1910,7 @@ Customizing file parsing
 
    Arguments that are read from a file (see the *fromfile_prefix_chars*
    keyword argument to the :class:`ArgumentParser` constructor) are read one
-   argument per line. :meth:`convert_arg_line_to_args` can be overriden for
+   argument per line. :meth:`convert_arg_line_to_args` can be overridden for
    fancier reading.
 
    This method takes a single argument *arg_line* which is a string read from
index 80d2a5d2c2b4efa0f8787860c4f09558d50203dd..1ab2d7423fc4906c9dd293432eba5c8fc1c9fcaf 100644 (file)
@@ -259,7 +259,7 @@ immediate playback::
             'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
             goto(*parse(arg))
         def do_home(self, arg):
-            'Return turtle to the home postion:  HOME'
+            'Return turtle to the home position:  HOME'
             home()
         def do_circle(self, arg):
             'Draw circle with given radius an options extent and steps:  CIRCLE 50'
index 599e9fa03a2442ad7c6c0fe99af3a13b8a8ab205..99c43113e3d0138414dab8503c4a71aae40cd3db 100644 (file)
@@ -179,7 +179,7 @@ Notes on using :class:`Set` and :class:`MutableSet` as a mixin:
 (3)
    The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value
    for the set; however, :meth:`__hash__` is not defined because not all sets
-   are hashable or immutable.  To add set hashabilty using mixins,
+   are hashable or immutable.  To add set hashability using mixins,
    inherit from both :meth:`Set` and :meth:`Hashable`, then define
    ``__hash__ = Set._hash``.
 
index b6ffd5e8119c22cd6b916ae5d76dbce13f9112d7..766bd38c59a85bec6064b6e1d863ba5944c71eec 100644 (file)
@@ -987,7 +987,7 @@ semantics pass-in keyword arguments using a regular unordered dictionary.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Since an ordered dictionary remembers its insertion order, it can be used
-in conjuction with sorting to make a sorted dictionary::
+in conjunction with sorting to make a sorted dictionary::
 
     >>> # regular unsorted dictionary
     >>> d = {'banana': 3, 'apple':4, 'pear': 1, 'orange': 2}
index 024d27cb84dd5cf42dda734692859e28d622c4dc..92551bc3bd42f2a618a2b1e72889cd53d70422a7 100644 (file)
@@ -386,7 +386,7 @@ However, there are a few differences that should be taken into account:
 * All sections include ``DEFAULTSECT`` values as well which means that
   ``.clear()`` on a section may not leave the section visibly empty.  This is
   because default values cannot be deleted from the section (because technically
-  they are not there).  If they are overriden in the section, deleting causes
+  they are not there).  If they are overridden in the section, deleting causes
   the default value to be visible again.  Trying to delete a default value
   causes a ``KeyError``.
 
@@ -667,7 +667,7 @@ the :meth:`__init__` options:
 
 More advanced customization may be achieved by overriding default values of
 these parser attributes.  The defaults are defined on the classes, so they
-may be overriden by subclasses or by attribute assignment.
+may be overridden by subclasses or by attribute assignment.
 
 .. attribute:: BOOLEAN_STATES
 
index a75015555d0b34deaa0138fa315e016fffe0b54a..1c3e20260936cfb4c1b8327c10573aa243803111 100644 (file)
@@ -232,7 +232,7 @@ of which this module provides three different variants:
 
    .. method:: send_response_only(code, message=None)
 
-      Sends the reponse header only, used for the purposes when ``100
+      Sends the response header only, used for the purposes when ``100
       Continue`` response is sent by the server to the client. The headers not
       buffered and sent directly the output stream.If the *message* is not
       specified, the HTTP message corresponding the response *code*  is sent.
index ca8798058e4dbdce43b6072299f71309f52ca2fc..99b5bea47d9c125fd4eab4816480da1c6f17a4d7 100644 (file)
@@ -103,7 +103,7 @@ write code that handles both IP versions correctly.
    1. A string in decimal-dot notation, consisting of four decimal integers in
       the inclusive range 0-255, separated by dots (e.g. ``192.168.0.1``). Each
       integer represents an octet (byte) in the address. Leading zeroes are
-      tolerated only for values less then 8 (as there is no ambiguity
+      tolerated only for values less than 8 (as there is no ambiguity
       between the decimal and octal interpretations of such strings).
    2. An integer that fits into 32 bits.
    3. An integer packed into a :class:`bytes` object of length 4 (most
index 63aba1e194525b1519a281eba1c72cc4f87c3060..d946892eccf429095ab71193e0fb1c9cc8895d64 100644 (file)
@@ -436,7 +436,7 @@ sends logging output to a network socket. The base class uses a TCP socket.
    .. method:: createSocket()
 
       Tries to create a socket; on failure, uses an exponential back-off
-      algorithm.  On intial failure, the handler will drop the message it was
+      algorithm.  On initial failure, the handler will drop the message it was
       trying to send.  When subsequent messages are handled by the same
       instance, it will not try connecting until some time has passed.  The
       default parameters are such that the initial delay is one second, and if
index 2bef120f1ddc3251304864d877a2dd402669f824..416559114b29222f0816777825e066ad040ef104 100644 (file)
@@ -129,7 +129,7 @@ The following functions are deprecated:
    and binary) file object. Returns the unpacked root object (which usually
    is a dictionary).
 
-   This function calls :func:`load` to do the actual work, the the documentation
+   This function calls :func:`load` to do the actual work, see the documentation
    of :func:`that function <load>` for an explanation of the keyword arguments.
 
    .. note::
index f8112cc0e498c023e531f7bf2e01b5b2cde862e1..7c0e4caf75ac0426aff0e5867202621db2e09304 100644 (file)
@@ -45,7 +45,7 @@ this module for those platforms.
 
 .. data:: RLIM_INFINITY
 
-   Constant used to represent the the limit for an unlimited resource.
+   Constant used to represent the limit for an unlimited resource.
 
 
 .. function:: getrlimit(resource)
index 734e426acdec88b20cf91e9bd5b46570269d6c7b..5334af8ea4ae9bcac27e56c58552551a51124cc7 100644 (file)
@@ -207,7 +207,7 @@ object.
    .. warning::
 
       Registering a file descriptor that's already registered is not an
-      error, but the result is undefined. The appropiate action is to
+      error, but the result is undefined. The appropriate action is to
       unregister or modify it first. This is an important difference
       compared with :c:func:`poll`.
 
index cd86e92944e17bc655c32a248a4f45d028e41e2c..04afe928c8de50cf96fa310052059518513330c3 100644 (file)
@@ -338,7 +338,7 @@ Directory and files operations
 
    On Windows, the current directory is always prepended to the *path* whether
    or not you use the default or provide your own, which is the behavior the
-   command shell uses when finding executables.  Additionaly, when finding the
+   command shell uses when finding executables.  Additionally, when finding the
    *cmd* in the *path*, the ``PATHEXT`` environment variable is checked.  For
    example, if you call ``shutil.which("python")``, :func:`which` will search
    ``PATHEXT`` to know that it should look for ``python.exe`` within the *path*
index e57b8ccc2d8bfbc403df7c8835a8aa1718cb0005..51e5da81d1ef4662482af50ac4d24f321f1db2c4 100644 (file)
@@ -184,7 +184,7 @@ Module contents
    unless the Python interpreter was started with the :option:`-S` flag.
 
    .. versionchanged:: 3.3
-      This function used to be called unconditionnally.
+      This function used to be called unconditionally.
 
 
 .. function:: addsitedir(sitedir, known_paths=None)
index b653c5387ed5af9458039e8187793af68e8399e3..827191ecf347d470d659aa6d90f31409747a32d8 100644 (file)
@@ -1449,7 +1449,7 @@ After binding (:const:`CAN_RAW`) or connecting (:const:`CAN_BCM`) the socket, yo
 can use the :meth:`socket.send`, and the :meth:`socket.recv` operations (and
 their counterparts) on the socket object as usual.
 
-This example might require special priviledge::
+This example might require special privileges::
 
    import socket
    import struct
index 0133a8f5e71f5840c67094516e4ce166212edd80..5269994781c6296d4a2d4bc3bba4c49f7d5450a4 100644 (file)
@@ -630,7 +630,7 @@ item to the buffer only needs to wake up one consumer thread.
             cv.wait()
 
       Therefore, the same rules apply as with :meth:`wait`: The lock must be
-      held when called and is re-aquired on return.  The predicate is evaluated
+      held when called and is re-acquired on return.  The predicate is evaluated
       with the lock held.
 
       .. versionadded:: 3.2
index 6f8bf1c315dae85f49f371ef76819067aade8137..b0eefcb7024f53ed90fb2ac65c6e24acd52b6798 100644 (file)
@@ -1167,7 +1167,7 @@ Ttk Styling
 Each widget in :mod:`ttk` is assigned a style, which specifies the set of
 elements making up the widget and how they are arranged, along with dynamic
 and default settings for element options. By default the style name is the
-same as the widget's class name, but it may be overriden by the widget's style
+same as the widget's class name, but it may be overridden by the widget's style
 option. If you don't know the class name of a widget, use the method
 :meth:`Misc.winfo_class` (somewidget.winfo_class()).
 
index 552e84b4e0254151e905cdb112631740e91caa56..a04a4327167b8119cf67d732ed8521138eab24f2 100644 (file)
@@ -350,7 +350,7 @@ Functions
    the *nframe* parameter of the :func:`start` function to store more frames.
 
    The :mod:`tracemalloc` module must be tracing memory allocations to take a
-   snapshot, see the the :func:`start` function.
+   snapshot, see the :func:`start` function.
 
    See also the :func:`get_object_traceback` function.
 
index 5899f3dddcf00b7159e44850883505f421a1ad22..efe5c54edf87511f8003aea6515725b932397049 100644 (file)
@@ -1809,7 +1809,7 @@ Input methods
 
    Pop up a dialog window for input of a number. title is the title of the
    dialog window, prompt is a text mostly describing what numerical information
-   to input. default: default value, minval: minimum value for imput,
+   to input. default: default value, minval: minimum value for input,
    maxval: maximum value for input
    The number input must be in the range minval .. maxval if these are
    given. If not, a hint is issued and the dialog remains open for
@@ -2402,7 +2402,7 @@ Changes since Python 3.0
   Accordingly the latter has got an alias: :meth:`Screen.onkeyrelease`.
 
 - The method  :meth:`Screen.mainloop` has been added. So when working only
-  with Screen and Turtle objects one must not additonally import
+  with Screen and Turtle objects one must not additionally import
   :func:`mainloop` anymore.
 
 - Two input methods has been added :meth:`Screen.textinput` and
index 03ce7523da3dbf0d3ee703560a918ac3be22b6a8..75b95d9b4a7bcb695512f45960d5081042b0be3b 100644 (file)
@@ -68,7 +68,7 @@ The :mod:`urllib.request` module defines the following functions:
    :class:`http.client.HTTPResponse` object which has the following
    :ref:`httpresponse-objects` methods.
 
-   For ftp, file, and data urls and requests explicity handled by legacy
+   For ftp, file, and data urls and requests explicitly handled by legacy
    :class:`URLopener` and :class:`FancyURLopener` classes, this function
    returns a :class:`urllib.response.addinfourl` object which can work as
    :term:`context manager` and has methods such as
index 9ca60a903f93f088841f18c6021efad4ff837b2b..cc883b1b51833309d77068864c9cf00347a4dfd3 100644 (file)
@@ -566,8 +566,8 @@ third party, such as running code when a module is unloaded::
 
 .. note::
 
-   If you create a finalizer object in a daemonic thread just as the
-   the program exits then there is the possibility that the finalizer
+   If you create a finalizer object in a daemonic thread just as the program
+   exits then there is the possibility that the finalizer
    does not get called at exit.  However, in a daemonic thread
    :func:`atexit.register`, ``try: ... finally: ...`` and ``with: ...``
    do not guarantee that cleanup occurs either.
index 19512ed3f764646a62149fe93b212e801fe76135..4914738dfc6a50b47907be532f87af2246ea647d 100644 (file)
@@ -412,7 +412,7 @@ objects:
 .. method:: NodeList.item(i)
 
    Return the *i*'th item from the sequence, if there is one, or ``None``.  The
-   index *i* is not allowed to be less then zero or greater than or equal to the
+   index *i* is not allowed to be less than zero or greater than or equal to the
    length of the sequence.
 
 
index 5058bf1d5a499df29a06910d1d902a2ee07e1a6c..ff1566226d0587a814d3228218ee7e94b5ccacb8 100644 (file)
@@ -219,7 +219,7 @@ comparison.  I won't cover the C API here, but will refer you to PEP 207, or to
 
 .. seealso::
 
-   :pep:`207` - Rich Comparisions
+   :pep:`207` - Rich Comparisons
       Written by Guido van Rossum, heavily based on earlier work by David Ascher, and
       implemented by Guido van Rossum.
 
index 1fdb365847a4bae7b7001d79902d94b220133304..1d4ce7236f33bbcf9eddd57cc40499920055a313 100644 (file)
@@ -1579,7 +1579,7 @@ os
   avoid race conditions in multi-threaded programs.
 
 * The :mod:`os` module has a new :func:`~os.sendfile` function which provides
-  an efficent "zero-copy" way for copying data from one file (or socket)
+  an efficient "zero-copy" way for copying data from one file (or socket)
   descriptor to another. The phrase "zero-copy" refers to the fact that all of
   the copying of data between the two descriptors is done entirely by the
   kernel, with no copying of data into userspace buffers. :func:`~os.sendfile`
@@ -1908,7 +1908,7 @@ socketserver
 :meth:`~socketserver.BaseServer.service_actions` that is called by the
 :meth:`~socketserver.BaseServer.serve_forever` method in the service loop.
 :class:`~socketserver.ForkingMixIn` now uses this to clean up zombie
-child proceses.  (Contributed by Justin Warkentin in :issue:`11109`.)
+child processes.  (Contributed by Justin Warkentin in :issue:`11109`.)
 
 
 sqlite3
@@ -2360,7 +2360,7 @@ Porting Python code
   bytecode file, make sure to call :func:`importlib.invalidate_caches` to clear
   out the cache for the finders to notice the new file.
 
-* :exc:`ImportError` now uses the full name of the module that was attemped to
+* :exc:`ImportError` now uses the full name of the module that was attempted to
   be imported. Doctests that check ImportErrors' message will need to be
   updated to use the full name of the module instead of just the tail of the
   name.