diff options
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/arg.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/function.rst | 2 | ||||
-rw-r--r-- | Doc/howto/pyporting.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-eventloop.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-task.rst | 2 | ||||
-rw-r--r-- | Doc/library/ctypes.rst | 32 | ||||
-rw-r--r-- | Doc/library/nis.rst | 6 | ||||
-rw-r--r-- | Doc/library/signal.rst | 2 | ||||
-rw-r--r-- | Doc/library/smtplib.rst | 4 | ||||
-rw-r--r-- | Doc/library/tarfile.rst | 2 | ||||
-rw-r--r-- | Doc/using/cmdline.rst | 2 | ||||
-rw-r--r-- | Doc/whatsnew/3.3.rst | 6 | ||||
-rw-r--r-- | Doc/whatsnew/3.5.rst | 14 |
13 files changed, 41 insertions, 41 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index f2bb8c6..983d113 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -30,7 +30,7 @@ variable(s) whose address should be passed. Strings and buffers ------------------- -These formats allow to access an object as a contiguous chunk of memory. +These formats allow accessing an object as a contiguous chunk of memory. You don't have to provide raw storage for the returned unicode or bytes area. Also, you won't have to release any memory yourself, except with the ``es``, ``es#``, ``et`` and ``et#`` formats. diff --git a/Doc/c-api/function.rst b/Doc/c-api/function.rst index ad98322..4c74dc8 100644 --- a/Doc/c-api/function.rst +++ b/Doc/c-api/function.rst @@ -40,7 +40,7 @@ There are a few functions specific to Python functions. .. c:function:: PyObject* PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname) - As :c:func:`PyFunction_New`, but also allows to set the function object's + As :c:func:`PyFunction_New`, but also allows setting the function object's ``__qualname__`` attribute. *qualname* should be a unicode object or NULL; if NULL, the ``__qualname__`` attribute is set to the same value as its ``__name__`` attribute. diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index a2aaf36..87b68d4 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -243,8 +243,8 @@ bothered to add the ``b`` mode when opening a binary file (e.g., ``rb`` for binary reading). Under Python 3, binary files and text files are clearly distinct and mutually incompatible; see the :mod:`io` module for details. Therefore, you **must** make a decision of whether a file will be used for -binary access (allowing to read and/or write binary data) or text access -(allowing to read and/or write text data). You should also use :func:`io.open` +binary access (allowing binary data to be read and/or written) or text access +(allowing text data to be read and/or written). You should also use :func:`io.open` for opening files instead of the built-in :func:`open` function as the :mod:`io` module is consistent from Python 2 to 3 while the built-in :func:`open` function is not (in Python 3 it's actually :func:`io.open`). diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 01f4228..659b37c 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -253,7 +253,7 @@ Creating connections a class. For example, if you want to use a pre-created protocol instance, you can pass ``lambda: my_protocol``. - Options allowing to change how the connection is created: + Options that change how the connection is created: * *ssl*: if given and not false, a SSL/TLS transport is created (by default a plain TCP transport is created). If *ssl* is @@ -654,7 +654,7 @@ pool of processes). By default, an event loop uses a thread pool executor Error Handling API ------------------ -Allows to customize how exceptions are handled in the event loop. +Allows customizing how exceptions are handled in the event loop. .. method:: BaseEventLoop.set_exception_handler(handler) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index febb734..fc73c20 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -510,7 +510,7 @@ Task functions .. note:: - In the functions below, the optional *loop* argument allows to explicitly set + In the functions below, the optional *loop* argument allows explicitly setting the event loop object used by the underlying task or coroutine. If it's not provided, the default event loop is used. diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst index 9abd469..3b0c956 100644 --- a/Doc/library/ctypes.rst +++ b/Doc/library/ctypes.rst @@ -942,7 +942,7 @@ other, and finally follow the pointer chain a few times:: Callback functions ^^^^^^^^^^^^^^^^^^ -:mod:`ctypes` allows to create C callable function pointers from Python callables. +:mod:`ctypes` allows creating C callable function pointers from Python callables. These are sometimes called *callback functions*. First, you must create a class for the callback function. The class knows the @@ -1350,7 +1350,7 @@ details, consult the :manpage:`dlopen(3)` manpage, on Windows, *mode* is ignored. The *use_errno* parameter, when set to True, enables a ctypes mechanism that -allows to access the system :data:`errno` error number in a safe way. +allows accessing the system :data:`errno` error number in a safe way. :mod:`ctypes` maintains a thread-local copy of the systems :data:`errno` variable; if you call foreign functions created with ``use_errno=True`` then the :data:`errno` value before the function call is swapped with the ctypes private @@ -1421,7 +1421,7 @@ loader instance. Class which loads shared libraries. *dlltype* should be one of the :class:`CDLL`, :class:`PyDLL`, :class:`WinDLL`, or :class:`OleDLL` types. - :meth:`__getattr__` has special behavior: It allows to load a shared library by + :meth:`__getattr__` has special behavior: It allows loading a shared library by accessing it as attribute of a library loader instance. The result is cached, so repeated attribute accesses return the same library each time. @@ -1498,7 +1498,7 @@ They are instances of a private class: It is possible to assign a callable Python object that is not a ctypes type, in this case the function is assumed to return a C :c:type:`int`, and - the callable will be called with this integer, allowing to do further + the callable will be called with this integer, allowing further processing or error checking. Using this is deprecated, for more flexible post processing or error checking use a ctypes data type as :attr:`restype` and assign a callable to the :attr:`errcheck` attribute. @@ -1513,7 +1513,7 @@ They are instances of a private class: When a foreign function is called, each actual argument is passed to the :meth:`from_param` class method of the items in the :attr:`argtypes` - tuple, this method allows to adapt the actual argument to an object that + tuple, this method allows adapting the actual argument to an object that the foreign function accepts. For example, a :class:`c_char_p` item in the :attr:`argtypes` tuple will convert a string passed as argument into a bytes object using ctypes conversion rules. @@ -1521,7 +1521,7 @@ They are instances of a private class: New: It is now possible to put items in argtypes which are not ctypes types, but each item must have a :meth:`from_param` method which returns a value usable as argument (integer, string, ctypes instance). This allows - to define adapters that can adapt custom objects as function parameters. + defining adapters that can adapt custom objects as function parameters. .. attribute:: errcheck @@ -1535,12 +1535,12 @@ They are instances of a private class: *result* is what the foreign function returns, as specified by the :attr:`restype` attribute. - *func* is the foreign function object itself, this allows to reuse the + *func* is the foreign function object itself, this allows reusing the same callable object to check or post process the results of several functions. *arguments* is a tuple containing the parameters originally passed to - the function call, this allows to specialize the behavior on the + the function call, this allows specializing the behavior on the arguments used. The object that this function returns will be returned from the @@ -1785,7 +1785,7 @@ Utility functions If a bytes object is specified as first argument, the buffer is made one item larger than its length so that the last element in the array is a NUL termination character. An integer can be passed as second argument which allows - to specify the size of the array if the length of the bytes should not be used. + specifying the size of the array if the length of the bytes should not be used. @@ -1800,21 +1800,21 @@ Utility functions If a string is specified as first argument, the buffer is made one item larger than the length of the string so that the last element in the array is a NUL termination character. An integer can be passed as second argument which - allows to specify the size of the array if the length of the string should not + allows specifying the size of the array if the length of the string should not be used. .. function:: DllCanUnloadNow() - Windows only: This function is a hook which allows to implement in-process + Windows only: This function is a hook which allows implementing in-process COM servers with ctypes. It is called from the DllCanUnloadNow function that the _ctypes extension dll exports. .. function:: DllGetClassObject() - Windows only: This function is a hook which allows to implement in-process + Windows only: This function is a hook which allows implementing in-process COM servers with ctypes. It is called from the DllGetClassObject function that the ``_ctypes`` extension dll exports. @@ -2321,7 +2321,7 @@ other data types containing pointer type fields. checked, only one field can be accessed when names are repeated. It is possible to define the :attr:`_fields_` class variable *after* the - class statement that defines the Structure subclass, this allows to create + class statement that defines the Structure subclass, this allows creating data types that directly or indirectly reference themselves:: class List(Structure): @@ -2342,7 +2342,7 @@ other data types containing pointer type fields. .. attribute:: _pack_ - An optional small integer that allows to override the alignment of + An optional small integer that allows overriding the alignment of structure fields in the instance. :attr:`_pack_` must already be defined when :attr:`_fields_` is assigned, otherwise it will have no effect. @@ -2354,8 +2354,8 @@ other data types containing pointer type fields. assigned, otherwise it will have no effect. The fields listed in this variable must be structure or union type fields. - :mod:`ctypes` will create descriptors in the structure type that allows to - access the nested fields directly, without the need to create the + :mod:`ctypes` will create descriptors in the structure type that allows + accessing the nested fields directly, without the need to create the structure or union field. Here is an example type (Windows):: diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst index ade2a7a..9e2b572 100644 --- a/Doc/library/nis.rst +++ b/Doc/library/nis.rst @@ -26,7 +26,7 @@ The :mod:`nis` module defines the following functions: Note that *mapname* is first checked if it is an alias to another name. - The *domain* argument allows to override the NIS domain used for the lookup. If + The *domain* argument allows overriding the NIS domain used for the lookup. If unspecified, lookup is in the default NIS domain. @@ -38,7 +38,7 @@ The :mod:`nis` module defines the following functions: Note that *mapname* is first checked if it is an alias to another name. - The *domain* argument allows to override the NIS domain used for the lookup. If + The *domain* argument allows overriding the NIS domain used for the lookup. If unspecified, lookup is in the default NIS domain. @@ -46,7 +46,7 @@ The :mod:`nis` module defines the following functions: Return a list of all valid maps. - The *domain* argument allows to override the NIS domain used for the lookup. If + The *domain* argument allows overriding the NIS domain used for the lookup. If unspecified, lookup is in the default NIS domain. diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 8f814df..e3efc8b 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -11,7 +11,7 @@ This module provides mechanisms to use signal handlers in Python. General rules ------------- -The :func:`signal.signal` function allows to define custom handlers to be +The :func:`signal.signal` function allows defining custom handlers to be executed when a signal is received. A small number of default handlers are installed: :const:`SIGPIPE` is ignored (so write errors on pipes and sockets can be reported as ordinary Python exceptions) and :const:`SIGINT` is diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 8cbd20d..2234d51 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -33,7 +33,7 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). *timeout* parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). If the timeout expires, :exc:`socket.timeout` is - raised. The optional source_address parameter allows to bind + raised. The optional source_address parameter allows binding to some specific source address in a machine with multiple network interfaces, and/or to some specific source TCP port. It takes a 2-tuple (host, port), for the socket to bind to as its source address before @@ -76,7 +76,7 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). *port* is zero, the standard SMTP-over-SSL port (465) is used. The optional arguments *local_hostname*, *timeout* and *source_address* have the same meaning as they do in the :class:`SMTP` class. *context*, also optional, - can contain a :class:`~ssl.SSLContext` and allows to configure various + can contain a :class:`~ssl.SSLContext` and allows configuring various aspects of the secure connection. Please read :ref:`ssl-security` for best practices. diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index adacb0a..e418d5b 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -111,7 +111,7 @@ Some facts and figures: specifies the blocksize and defaults to ``20 * 512`` bytes. Use this variant in combination with e.g. ``sys.stdin``, a socket :term:`file object` or a tape device. However, such a :class:`TarFile` object is limited in that it does - not allow to be accessed randomly, see :ref:`tar-examples`. The currently + not allow random access, see :ref:`tar-examples`. The currently possible modes: +-------------+--------------------------------------------+ diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index af86055..7ec9dce 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -398,7 +398,7 @@ Miscellaneous options tracing with a traceback limit of *NFRAME* frames. See the :func:`tracemalloc.start` for more information. - It also allows to pass arbitrary values and retrieve them through the + It also allows passing arbitrary values and retrieving them through the :data:`sys._xoptions` dictionary. .. versionchanged:: 3.2 diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index 094eff8..6ee40cd 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -1528,7 +1528,7 @@ by Petri Lehtinen in :issue:`12021`.) multiprocessing --------------- -The new :func:`multiprocessing.connection.wait` function allows to poll +The new :func:`multiprocessing.connection.wait` function allows polling multiple objects (such as connections, sockets and pipes) with a timeout. (Contributed by Richard Oudkerk in :issue:`12328`.) @@ -1715,8 +1715,8 @@ pickle ------ :class:`pickle.Pickler` objects now have an optional -:attr:`~pickle.Pickler.dispatch_table` attribute allowing to set per-pickler -reduction functions. +:attr:`~pickle.Pickler.dispatch_table` attribute allowing per-pickler +reduction functions to be set. (Contributed by Richard Oudkerk in :issue:`14166`.) diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst index bb520dc..52a6e91 100644 --- a/Doc/whatsnew/3.5.rst +++ b/Doc/whatsnew/3.5.rst @@ -748,7 +748,7 @@ Improved Modules argparse -------- -The :class:`~argparse.ArgumentParser` class now allows to disable +The :class:`~argparse.ArgumentParser` class now allows disabling :ref:`abbreviated usage <prefix-matching>` of long options by setting :ref:`allow_abbrev` to ``False``. (Contributed by Jonathan Paugh, Steven Bethard, paul j3 and Daniel Eriksson in :issue:`14910`.) @@ -913,12 +913,12 @@ external `PyPI package <https://pypi.python.org/pypi/backports_abc>`_. compileall ---------- -A new :mod:`compileall` option, :samp:`-j {N}`, allows to run *N* workers +A new :mod:`compileall` option, :samp:`-j {N}`, allows running *N* workers simultaneously to perform parallel bytecode compilation. The :func:`~compileall.compile_dir` function has a corresponding ``workers`` parameter. (Contributed by Claudiu Popa in :issue:`16104`.) -Another new option, ``-r``, allows to control the maximum recursion +Another new option, ``-r``, allows controlling the maximum recursion level for subdirectories. (Contributed by Claudiu Popa in :issue:`19628`.) The ``-q`` command line option can now be specified more than once, in @@ -1453,8 +1453,8 @@ or newer, and ``getentropy()`` on OpenBSD 5.6 and newer, removing the need to use ``/dev/urandom`` and avoiding failures due to potential file descriptor exhaustion. (Contributed by Victor Stinner in :issue:`22181`.) -New :func:`~os.get_blocking` and :func:`~os.set_blocking` functions allow to -get and set a file descriptor's blocking mode (:data:`~os.O_NONBLOCK`.) +New :func:`~os.get_blocking` and :func:`~os.set_blocking` functions allow +getting and setting a file descriptor's blocking mode (:data:`~os.O_NONBLOCK`.) (Contributed by Victor Stinner in :issue:`22054`.) The :func:`~os.truncate` and :func:`~os.ftruncate` functions are now supported @@ -1681,8 +1681,8 @@ socket Functions with timeouts now use a monotonic clock, instead of a system clock. (Contributed by Victor Stinner in :issue:`22043`.) -A new :meth:`socket.sendfile() <socket.socket.sendfile>` method allows to -send a file over a socket by using the high-performance :func:`os.sendfile` +A new :meth:`socket.sendfile() <socket.socket.sendfile>` method allows +sending a file over a socket by using the high-performance :func:`os.sendfile` function on UNIX, resulting in uploads being from 2 to 3 times faster than when using plain :meth:`socket.send() <socket.socket.send>`. (Contributed by Giampaolo Rodola' in :issue:`17552`.) |