]> granicus.if.org Git - python/commitdiff
Fix Issue #21528 - Fix documentation typos
authorDonald Stufft <donald@stufft.io>
Tue, 20 May 2014 16:58:38 +0000 (12:58 -0400)
committerDonald Stufft <donald@stufft.io>
Tue, 20 May 2014 16:58:38 +0000 (12:58 -0400)
32 files changed:
Doc/distutils/apiref.rst
Doc/distutils/builtdist.rst
Doc/howto/clinic.rst
Doc/howto/pyporting.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/copyreg.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/ssl.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/webbrowser.rst
Doc/library/xml.dom.rst
Doc/whatsnew/2.1.rst
Doc/whatsnew/3.3.rst

index e1357fa90ded87cd7378fc588df7d3d6611eafbc..4c38a07a69699e5038bae6d4d3b78e1053dd7449 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 83c68ae20c75fda51b54b8b37d748f5e948e1b77..a67c68e21ab20c76d7cf69a2e69eccc75672c0c0 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 750ddbe07478fd872eea4469fb6b7f822ad80f7d..ca8e1cb87ba92e06bd8bf0660fa065d85ed91f90 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 9d7e8598c14db66b824b494d653776b25c2fea4d..17fc81bfa637d1023ee4eb8192588e17828c29f0 100644 (file)
@@ -60,7 +60,7 @@ If your project is on the Cheeseshop_/PyPI_, make sure it has the proper
 `trove classifiers`_ to signify what versions of Python it **currently**
 supports. At minimum you should specify the major version(s), e.g.
 ``Programming Language :: Python :: 2`` if your project currently only supports
-Python 2. It is preferrable that you be as specific as possible by listing every
+Python 2. It is preferable that you be as specific as possible by listing every
 major/minor version of Python that you support, e.g. if your project supports
 Python 2.6 and 2.7, then you want the classifiers of::
 
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 820beb5cff2d1a9a6f5c63767813bdd0990dad54..b482c57353fc27bec99323d78e0470ae08dedeee 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 b1b5135eac181f1cecfb2c95f20a157fa861d126..36dc5f384b2d6085d1bab68a8937bbf0cf00297b 100644 (file)
@@ -1873,7 +1873,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 97229280c31f81ff1cf197e0ca9f0aad9c7a9fc8..6d57b77ccf5b4b5351a71fd87db467c3d2de1672 100644 (file)
@@ -252,7 +252,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 356f47332f6750dfa6b6ce797d31689704c99996..efa922b9213f04c33ffb70e59647941d0a7dd012 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 06ba0420c5b61f152354cbe5730c2bec5a7293e1..3ec32407951de147cdb1236950e0c61efee4e250 100644 (file)
@@ -986,7 +986,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 bd6c36410edb4c72afe54c373fa2ff51792a934f..4d65a821d7814d3805a3e6889c200e3b673f9dcc 100644 (file)
@@ -388,7 +388,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``.
 
@@ -669,7 +669,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 50d5879ae529bc81b16c52580a933fb96c014651..18306c7f99f08dc13aa9bdccc36e1b92fee585b7 100644 (file)
@@ -9,7 +9,7 @@
    module: pickle
    module: copy
 
-The :mod:`copyreg` module offers a way to define fuctions used while pickling
+The :mod:`copyreg` module offers a way to define functions used while pickling
 specific objects.  The :mod:`pickle` and :mod:`copy` modules use those functions
 when pickling/copying those objects.  The module provides configuration
 information about object constructors which are not classes.
index 0d8e7fe6c77c3aa3f1295d56180d656e23900286..ec5464332e32a0f2a1fd417e761adb07dccb2c3c 100644 (file)
@@ -220,7 +220,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 6899cf64d55541caf264d01ac6becde592ab256d..d48fac95f48c4e81ac6649b015385a310e6f9b4a 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 315c168f1ddf93909b048f9b8979c47e27a893eb..9f3b074b1bded4ff1809be710350181ce4ff2ef1 100644 (file)
@@ -435,7 +435,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 6a2d6b4971c088d98eb0b4cfedf9931f11d63a2b..b0d5bcf1055cca7f7235c496a92ac0d5126c057a 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 973a0cc7d6f0fef2b3a7b54c0be5602ddaf09d32..a5e0c133e95a54f2f175cadd034bee553e2c1f49 100644 (file)
@@ -210,7 +210,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 3ed1d05194cd4d26d1d4039f3437ecf7e99c883d..7cc397da694d3d14457d2cc06dec3e6c74957720 100644 (file)
@@ -341,7 +341,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 6beda84c145f1174f65161a6e0813eb67f909b5a..ee2a68a50f0854a37c82707470bf214ba2956c96 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 54c6badb13412f995d0ee59e18ac42b7483af79e..1f5a8e05e6569bf7f38c1cfc5bb2ff7f68b4c4af 100644 (file)
@@ -1444,7 +1444,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 f8bdcb01769b586cadf54dff22b30c98205c77c8..0b0edd874c2050f226655a1b78f933675e318fbd 100644 (file)
@@ -1021,7 +1021,7 @@ to speed up repeated connections from the same clients.
    :data:`CERT_NONE`.  At least one of *cafile* or *capath* must be specified.
 
    This method can also load certification revocation lists (CRLs) in PEM or
-   or DER format. In order to make use of CRLs, :attr:`SSLContext.verify_flags`
+   DER format. In order to make use of CRLs, :attr:`SSLContext.verify_flags`
    must be configured properly.
 
    The *cafile* string, if present, is the path to a file of concatenated
@@ -1693,7 +1693,7 @@ Manual settings
 Verifying certificates
 ''''''''''''''''''''''
 
-When calling the the :class:`SSLContext` constructor directly,
+When calling the :class:`SSLContext` constructor directly,
 :const:`CERT_NONE` is the default.  Since it does not authenticate the other
 peer, it can be insecure, especially in client mode where most of time you
 would like to ensure the authenticity of the server you're talking to.
index 4a3b3ea00b2157cf7284f7328e93fce362a696ef..03ee769bb0088d1b1609c570d187b7107814e4a2 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 3405518ab280e01f566bd683affaa54e9a931c2b..f1e260278d0a58d01918f0d152a5119ef7a7d5ff 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 0e3a9795fd6f3eb5bcbb5891b5217328189c2ba6..dbb1aa9e1f7027429bb5a6c4c355c8a05001c08f 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
@@ -2397,7 +2397,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 019f59cfbc25b7454578182efea48b776e718ca4..b588dad3a3442cbf23011c3bd27be48368e31b8a 100644 (file)
@@ -67,7 +67,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
@@ -1067,7 +1067,7 @@ The following W3C document, http://www.w3.org/International/O-charset\ , lists
 the various ways in which a (X)HTML or a XML document could have specified its
 encoding information.
 
-As the python.org website uses *utf-8* encoding as specified in it's meta tag, we
+As the python.org website uses *utf-8* encoding as specified in its meta tag, we
 will use the same for decoding the bytes object. ::
 
    >>> with urllib.request.urlopen('http://www.python.org/') as f:
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 ef6376999914b735a663cd5f455bb27bfc324bf8..aa5e4ad15d7692f867a8cbe935ba3f7c74acb4eb 100644 (file)
@@ -20,7 +20,7 @@ available.  If text-mode browsers are used, the calling process will block until
 the user exits the browser.
 
 If the environment variable :envvar:`BROWSER` exists, it is interpreted as the
-:data:`os.pathsep`-separated list of browsers to try ahead of the the platform
+:data:`os.pathsep`-separated list of browsers to try ahead of the platform
 defaults.  When the value of a list part contains the string ``%s``, then it is
 interpreted as a literal browser command line to be used with the argument URL
 substituted for ``%s``; if the part does not contain ``%s``, it is simply
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 b1ab48e7f4bf04f5560f18c127c3f363ddf65a06..144ea1c631d3a63dd011d432651f2c385641fc88 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 cda63e4928e2fa1614abd570656e279b04e6d7c4..7631e7512b9badf70f8b390ae106c86c09d7d5cb 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.