Fix Issue #21528 - Fix documentation typos
This commit is contained in:
parent
1c4398f880
commit
8b852f111e
|
@ -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:
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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::
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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'
|
||||
|
|
|
@ -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``.
|
||||
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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::
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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`.
|
||||
|
||||
|
|
|
@ -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*
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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()).
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue