Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)

Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
This commit is contained in:
Ned Batchelder 2022-07-05 05:16:10 -04:00 committed by GitHub
parent 2b8ed4d3d4
commit 3440d197a5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
71 changed files with 118 additions and 118 deletions

View file

@ -125,7 +125,7 @@ connection requests.
.. method:: async_chat.push_with_producer(producer)
Takes a producer object and adds it to the producer queue associated with
the channel. When all currently-pushed producers have been exhausted the
the channel. When all currently pushed producers have been exhausted the
channel will consume this producer's data by calling its :meth:`more`
method and send the data to the remote endpoint.

View file

@ -8,7 +8,7 @@ The modules described in this chapter allow writing interfaces similar to
Python's interactive interpreter. If you want a Python interpreter that
supports some special feature in addition to the Python language, you should
look at the :mod:`code` module. (The :mod:`codeop` module is lower-level, used
to support compiling a possibly-incomplete chunk of Python code.)
to support compiling a possibly incomplete chunk of Python code.)
The full list of modules described in this chapter is:

View file

@ -30,7 +30,7 @@
--------------
The :mod:`decimal` module provides support for fast correctly-rounded
The :mod:`decimal` module provides support for fast correctly rounded
decimal floating point arithmetic. It offers several advantages over the
:class:`float` datatype:
@ -1371,16 +1371,16 @@ In addition to the three supplied contexts, new contexts can be created with the
With two arguments, compute ``x**y``. If ``x`` is negative then ``y``
must be integral. The result will be inexact unless ``y`` is integral and
the result is finite and can be expressed exactly in 'precision' digits.
The rounding mode of the context is used. Results are always correctly-rounded
The rounding mode of the context is used. Results are always correctly rounded
in the Python version.
``Decimal(0) ** Decimal(0)`` results in ``InvalidOperation``, and if ``InvalidOperation``
is not trapped, then results in ``Decimal('NaN')``.
.. versionchanged:: 3.3
The C module computes :meth:`power` in terms of the correctly-rounded
The C module computes :meth:`power` in terms of the correctly rounded
:meth:`exp` and :meth:`ln` functions. The result is well-defined but
only "almost always correctly-rounded".
only "almost always correctly rounded".
With three arguments, compute ``(x**y) % modulo``. For the three argument
form, the following restrictions on the arguments hold:
@ -2151,7 +2151,7 @@ Q. Is the CPython implementation fast for large numbers?
A. Yes. In the CPython and PyPy3 implementations, the C/CFFI versions of
the decimal module integrate the high speed `libmpdec
<https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html>`_ library for
arbitrary precision correctly-rounded decimal floating point arithmetic [#]_.
arbitrary precision correctly rounded decimal floating point arithmetic [#]_.
``libmpdec`` uses `Karatsuba multiplication
<https://en.wikipedia.org/wiki/Karatsuba_algorithm>`_
for medium-sized numbers and the `Number Theoretic Transform

View file

@ -565,12 +565,12 @@ doctest decides whether actual output matches an example's expected output:
When specified, doctests expecting exceptions pass so long as an exception
of the expected type is raised, even if the details
(message and fully-qualified exception name) don't match.
(message and fully qualified exception name) don't match.
For example, an example expecting ``ValueError: 42`` will pass if the actual
exception raised is ``ValueError: 3*14``, but will fail if, say, a
:exc:`TypeError` is raised instead.
It will also ignore any fully-qualified name included before the
It will also ignore any fully qualified name included before the
exception class, which can vary between implementations and versions
of Python and the code/libraries in use.
Hence, all three of these variations will work with the flag specified:

View file

@ -42,7 +42,7 @@ For example, ``'[?]'`` matches the character ``'?'``.
.. function:: glob(pathname, *, root_dir=None, dir_fd=None, recursive=False, \
include_hidden=False)
Return a possibly-empty list of path names that match *pathname*, which must be
Return a possibly empty list of path names that match *pathname*, which must be
a string containing a path specification. *pathname* can be either absolute
(like :file:`/usr/src/Python-1.5/Makefile`) or relative (like
:file:`../../Tools/\*/\*.gif`), and can contain shell-style wildcards. Broken

View file

@ -69,7 +69,7 @@ An HMAC object has the following methods:
.. warning::
When comparing the output of :meth:`digest` to an externally-supplied
When comparing the output of :meth:`digest` to an externally supplied
digest during a verification routine, it is recommended to use the
:func:`compare_digest` function instead of the ``==`` operator
to reduce the vulnerability to timing attacks.
@ -83,7 +83,7 @@ An HMAC object has the following methods:
.. warning::
When comparing the output of :meth:`hexdigest` to an externally-supplied
When comparing the output of :meth:`hexdigest` to an externally supplied
digest during a verification routine, it is recommended to use the
:func:`compare_digest` function instead of the ``==`` operator
to reduce the vulnerability to timing attacks.

View file

@ -450,7 +450,7 @@ ABC hierarchy::
reloaded):
- :attr:`__name__`
The module's fully-qualified name.
The module's fully qualified name.
It is ``'__main__'`` for an executed module.
- :attr:`__file__`
@ -471,7 +471,7 @@ ABC hierarchy::
as an indicator that the module is a package.
- :attr:`__package__`
The fully-qualified name of the package the module is in (or the
The fully qualified name of the package the module is in (or the
empty string for a top-level module).
If the module is a package then this is the same as :attr:`__name__`.
@ -899,7 +899,7 @@ find and load modules.
(:attr:`__name__`)
The module's fully-qualified name.
The module's fully qualified name.
The :term:`finder` should always set this attribute to a non-empty string.
.. attribute:: loader
@ -948,7 +948,7 @@ find and load modules.
(:attr:`__package__`)
(Read-only) The fully-qualified name of the package the module is in (or the
(Read-only) The fully qualified name of the package the module is in (or the
empty string for a top-level module).
If the module is a package then this is the same as :attr:`name`.

View file

@ -187,7 +187,7 @@ attributes:
| | co_name | name with which this code |
| | | object was defined |
+-----------+-------------------+---------------------------+
| | co_qualname | fully-qualified name with |
| | co_qualname | fully qualified name with |
| | | which this code object |
| | | was defined |
+-----------+-------------------+---------------------------+
@ -1130,7 +1130,7 @@ Classes and functions
doesn't have its own annotations dict, returns an empty dict.
* All accesses to object members and dict values are done
using ``getattr()`` and ``dict.get()`` for safety.
* Always, always, always returns a freshly-created dict.
* Always, always, always returns a freshly created dict.
``eval_str`` controls whether or not values of type ``str`` are replaced
with the result of calling :func:`eval()` on those values:

View file

@ -1510,7 +1510,7 @@ The following exception classes are defined in the :mod:`mailbox` module:
Raised when some mailbox-related condition beyond the control of the program
causes it to be unable to proceed, such as when failing to acquire a lock that
another program already holds a lock, or when a uniquely-generated file name
another program already holds a lock, or when a uniquely generated file name
already exists.

View file

@ -529,7 +529,7 @@ help message:
line-wrapping---\ :mod:`optparse` takes care of wrapping lines and making
the help output look good.
* options that take a value indicate this fact in their automatically-generated
* options that take a value indicate this fact in their automatically generated
help message, e.g. for the "mode" option::
-m MODE, --mode=MODE
@ -539,7 +539,7 @@ help message:
:mod:`optparse` converts the destination variable name to uppercase and uses
that for the meta-variable. Sometimes, that's not what you want---for
example, the ``--filename`` option explicitly sets ``metavar="FILE"``,
resulting in this automatically-generated option description::
resulting in this automatically generated option description::
-f FILE, --filename=FILE
@ -1449,7 +1449,7 @@ intelligently and add conflicting options to it::
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")
At this point, :mod:`optparse` detects that a previously-added option is already
At this point, :mod:`optparse` detects that a previously added option is already
using the ``-n`` option string. Since ``conflict_handler`` is ``"resolve"``,
it resolves the situation by removing ``-n`` from the earlier option's list of
option strings. Now ``--dry-run`` is the only way for the user to activate
@ -1460,7 +1460,7 @@ that option. If the user asks for help, the help message will reflect that::
...
-n, --noisy be noisy
It's possible to whittle away the option strings for a previously-added option
It's possible to whittle away the option strings for a previously added option
until there are none left, and the user has no way of invoking that option from
the command-line. In that case, :mod:`optparse` removes that option completely,
so it doesn't show up in help text or anywhere else. Carrying on with our

View file

@ -2121,7 +2121,7 @@ features:
The *mode* parameter is passed to :func:`mkdir` for creating the leaf
directory; see :ref:`the mkdir() description <mkdir_modebits>` for how it
is interpreted. To set the file permission bits of any newly-created parent
is interpreted. To set the file permission bits of any newly created parent
directories you can set the umask before invoking :func:`makedirs`. The
file permission bits of existing parent directories are not changed.
@ -2152,7 +2152,7 @@ features:
.. versionchanged:: 3.7
The *mode* argument no longer affects the file permission bits of
newly-created intermediate-level directories.
newly created intermediate-level directories.
.. function:: mkfifo(path, mode=0o666, *, dir_fd=None)

View file

@ -44,7 +44,7 @@ randomness that your operating system provides.
.. function:: choice(sequence)
Return a randomly-chosen element from a non-empty sequence.
Return a randomly chosen element from a non-empty sequence.
.. function:: randbelow(n)
@ -155,7 +155,7 @@ Generate an eight-character alphanumeric password:
Applications should not
`store passwords in a recoverable format <http://cwe.mitre.org/data/definitions/257.html>`_,
whether plain text or encrypted. They should be salted and hashed
using a cryptographically-strong one-way (irreversible) hash function.
using a cryptographically strong one-way (irreversible) hash function.
Generate a ten-character alphanumeric password with at least one

View file

@ -252,7 +252,7 @@ object.
.. method:: devpoll.poll([timeout])
Polls the set of registered file descriptors, and returns a possibly-empty list
Polls the set of registered file descriptors, and returns a possibly empty list
containing ``(fd, event)`` 2-tuples for the descriptors that have events or
errors to report. *fd* is the file descriptor, and *event* is a bitmask with
bits set for the reported events for that descriptor --- :const:`POLLIN` for
@ -440,7 +440,7 @@ linearly scanned again. :c:func:`select` is O(highest file descriptor), while
.. method:: poll.poll([timeout])
Polls the set of registered file descriptors, and returns a possibly-empty list
Polls the set of registered file descriptors, and returns a possibly empty list
containing ``(fd, event)`` 2-tuples for the descriptors that have events or
errors to report. *fd* is the file descriptor, and *event* is a bitmask with
bits set for the reported events for that descriptor --- :const:`POLLIN` for

View file

@ -194,7 +194,7 @@ Directory and files operations
When *follow_symlinks* is false, and *src* is a symbolic
link, :func:`copy2` attempts to copy all metadata from the
*src* symbolic link to the newly-created *dst* symbolic link.
*src* symbolic link to the newly created *dst* symbolic link.
However, this functionality is not available on all platforms.
On platforms where some or all of this functionality is
unavailable, :func:`copy2` will preserve all the metadata

View file

@ -228,7 +228,7 @@ SMTPChannel Objects
.. attribute:: fqdn
Holds the fully-qualified domain name of the server as returned by
Holds the fully qualified domain name of the server as returned by
:func:`socket.getfqdn`.
.. attribute:: peer

View file

@ -125,7 +125,7 @@ created. Socket addresses are represented as follows:
- A string or a tuple ``(id, unit)`` is used for the :const:`SYSPROTO_CONTROL`
protocol of the :const:`PF_SYSTEM` family. The string is the name of a
kernel control using a dynamically-assigned ID. The tuple can be used if ID
kernel control using a dynamically assigned ID. The tuple can be used if ID
and unit number of the kernel control are known or if a registered ID is
used.
@ -956,7 +956,7 @@ The :mod:`socket` module also offers various network-related services:
.. function:: getnameinfo(sockaddr, flags)
Translate a socket address *sockaddr* into a 2-tuple ``(host, port)``. Depending
on the settings of *flags*, the result can contain a fully-qualified domain name
on the settings of *flags*, the result can contain a fully qualified domain name
or numeric address representation in *host*. Similarly, *port* can contain a
string port name or a numeric port number.

View file

@ -683,7 +683,7 @@ Connection Objects
If returning a tuple doesn't suffice and you want name-based access to
columns, you should consider setting :attr:`row_factory` to the
highly-optimized :class:`sqlite3.Row` type. :class:`Row` provides both
highly optimized :class:`sqlite3.Row` type. :class:`Row` provides both
index-based and case-insensitive name-based access to columns with almost no
memory overhead. It will probably be better than your own custom
dictionary-based approach or even a db_row based solution.

View file

@ -82,7 +82,7 @@ The module defines the following exception and functions:
Iteratively unpack from the buffer *buffer* according to the format
string *format*. This function returns an iterator which will read
equally-sized chunks from the buffer until all its contents have been
equally sized chunks from the buffer until all its contents have been
consumed. The buffer's size in bytes must be a multiple of the size
required by the format, as reflected by :func:`calcsize`.

View file

@ -359,7 +359,7 @@ functions.
.. warning::
For maximum reliability, use a fully-qualified path for the executable.
For maximum reliability, use a fully qualified path for the executable.
To search for an unqualified name on :envvar:`PATH`, use
:meth:`shutil.which`. On all platforms, passing :data:`sys.executable`
is the recommended way to launch the current Python interpreter again,
@ -1553,7 +1553,7 @@ On Linux, :mod:`subprocess` defaults to using the ``vfork()`` system call
internally when it is safe to do so rather than ``fork()``. This greatly
improves performance.
If you ever encounter a presumed highly-unusual situation where you need to
If you ever encounter a presumed highly unusual situation where you need to
prevent ``vfork()`` from being used by Python, you can set the
:attr:`subprocess._USE_VFORK` attribute to a false value.

View file

@ -839,7 +839,7 @@ There are three tar formats that can be created with the :mod:`tarfile` module:
files and stores pathnames in a portable way. Modern tar implementations,
including GNU tar, bsdtar/libarchive and star, fully support extended *pax*
features; some old or unmaintained libraries may not, but should treat
*pax* archives as if they were in the universally-supported *ustar* format.
*pax* archives as if they were in the universally supported *ustar* format.
It is the current default format for new archives.
It extends the existing *ustar* format with extra headers for information

View file

@ -286,7 +286,7 @@ methods :meth:`tkinter.Widget.cget` and :meth:`tkinter.Widget.configure`.
Modify or inquire widget state. If *statespec* is specified, sets the
widget state according to it and return a new *statespec* indicating
which flags were changed. If *statespec* is not specified, returns
the currently-enabled state flags.
the currently enabled state flags.
*statespec* will usually be a list or a tuple.
@ -465,7 +465,7 @@ Notebook
Ttk Notebook widget manages a collection of windows and displays a single
one at a time. Each child window is associated with a tab, which the user
may select to change the currently-displayed window.
may select to change the currently displayed window.
Options
@ -543,7 +543,7 @@ of the following forms:
* An integer between zero and the number of tabs
* The name of a child window
* A positional specification of the form "@x,y", which identifies the tab
* The literal string "current", which identifies the currently-selected tab
* The literal string "current", which identifies the currently selected tab
* The literal string "end", which returns the number of tabs (only valid for
:meth:`Notebook.index`)
@ -613,7 +613,7 @@ ttk.Notebook
Selects the specified *tab_id*.
The associated child window will be displayed, and the
previously-selected window (if different) is unmapped. If *tab_id* is
previously selected window (if different) is unmapped. If *tab_id* is
omitted, returns the widget name of the currently selected pane.

View file

@ -78,7 +78,7 @@ annotations. These include:
*Introducing* :data:`TypeVarTuple`
* :pep:`647`: User-Defined Type Guards
*Introducing* :data:`TypeGuard`
* :pep:`655`: Marking individual TypedDict items as required or potentially-missing
* :pep:`655`: Marking individual TypedDict items as required or potentially missing
*Introducing* :data:`Required` and :data:`NotRequired`
* :pep:`673`: Self type
*Introducing* :data:`Self`
@ -1034,7 +1034,7 @@ These can be used as types in annotations using ``[]``, each having a unique syn
as either required or non-required respectively.
For more information, see :class:`TypedDict` and
:pep:`655` ("Marking individual TypedDict items as required or potentially-missing").
:pep:`655` ("Marking individual TypedDict items as required or potentially missing").
.. versionadded:: 3.11

View file

@ -1279,7 +1279,7 @@ involved. For example, the :envvar:`http_proxy` environment variable is read to
obtain the HTTP proxy's URL.
This example replaces the default :class:`ProxyHandler` with one that uses
programmatically-supplied proxy URLs, and adds proxy authorization support with
programmatically supplied proxy URLs, and adds proxy authorization support with
:class:`ProxyBasicAuthHandler`. ::
proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'})

View file

@ -211,7 +211,7 @@ The :mod:`uuid` module defines the following namespace identifiers for use with
.. data:: NAMESPACE_DNS
When this namespace is specified, the *name* string is a fully-qualified domain
When this namespace is specified, the *name* string is a fully qualified domain
name.

View file

@ -163,9 +163,9 @@ the disposition of the match. Each entry is a tuple of the form (*action*,
category must be a subclass in order to match.
* *module* is a string containing a regular expression that the start of the
fully-qualified module name must match, case-sensitively. In :option:`-W` and
fully qualified module name must match, case-sensitively. In :option:`-W` and
:envvar:`PYTHONWARNINGS`, *module* is a literal string that the
fully-qualified module name must be equal to (case-sensitively), ignoring any
fully qualified module name must be equal to (case-sensitively), ignoring any
whitespace at the start or end of *module*.
* *lineno* is an integer that the line number where the warning occurred must

View file

@ -333,7 +333,7 @@ request. (E.g., using the :func:`shift_path_info` function from
.. method:: WSGIServer.get_app()
Returns the currently-set application callable.
Returns the currently set application callable.
Normally, however, you do not need to use these additional methods, as
:meth:`set_app` is normally called by :func:`make_server`, and the
@ -642,7 +642,7 @@ input, output, and error streams.
.. method:: BaseHandler.setup_environ()
Set the :attr:`environ` attribute to a fully-populated WSGI environment. The
Set the :attr:`environ` attribute to a fully populated WSGI environment. The
default implementation uses all of the above methods and attributes, plus the
:meth:`get_stdin`, :meth:`get_stderr`, and :meth:`add_cgi_vars` methods and the
:attr:`wsgi_file_wrapper` attribute. It also inserts a ``SERVER_SOFTWARE`` key

View file

@ -95,7 +95,7 @@ quadratic blowup entity expansion
entity expansion, too. Instead of nested entities it repeats one large entity
with a couple of thousand chars over and over again. The attack isn't as
efficient as the exponential case but it avoids triggering parser countermeasures
that forbid deeply-nested entities.
that forbid deeply nested entities.
external entity expansion
Entity declarations can contain more than just text for replacement. They can

View file

@ -47,7 +47,7 @@ between conformable Python objects and XML on the wire.
The following parameters govern the use of the returned proxy instance.
If *allow_none* is true, the Python constant ``None`` will be translated into
XML; the default behaviour is for ``None`` to raise a :exc:`TypeError`. This is
a commonly-used extension to the XML-RPC specification, but isn't supported by
a commonly used extension to the XML-RPC specification, but isn't supported by
all clients and servers; see `http://ontosys.com/xml-rpc/extensions.php
<https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php>`_
for a description.

View file

@ -265,7 +265,7 @@ Decompression objects support the following methods and attributes:
A boolean indicating whether the end of the compressed data stream has been
reached.
This makes it possible to distinguish between a properly-formed compressed
This makes it possible to distinguish between a properly formed compressed
stream, and an incomplete or truncated one.
.. versionadded:: 3.3