Skip to content

Commit 3440d19

Browse files
authored
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (pythonGH-94551)
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
1 parent 2b8ed4d commit 3440d19

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+118
-118
lines changed

Doc/c-api/allocation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Allocating Objects on the Heap
1414
1515
.. c:function:: PyObject* PyObject_Init(PyObject *op, PyTypeObject *type)
1616
17-
Initialize a newly-allocated object *op* with its type and initial
17+
Initialize a newly allocated object *op* with its type and initial
1818
reference. Returns the initialized object. If *type* indicates that the
1919
object participates in the cyclic garbage detector, it is added to the
2020
detector's set of observed objects. Other fields of the object are not

Doc/c-api/intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@ A full list of the various types of debugging builds is in the file
779779
:file:`Misc/SpecialBuilds.txt` in the Python source distribution. Builds are
780780
available that support tracing of reference counts, debugging the memory
781781
allocator, or low-level profiling of the main interpreter loop. Only the most
782-
frequently-used builds will be described in the remainder of this section.
782+
frequently used builds will be described in the remainder of this section.
783783

784784
Compiling the interpreter with the :c:macro:`Py_DEBUG` macro defined produces
785785
what is generally meant by :ref:`a debug build of Python <debug-build>`.

Doc/c-api/memory.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ memory manager. For example, this is required when the interpreter is extended
7575
with new object types written in C. Another reason for using the Python heap is
7676
the desire to *inform* the Python memory manager about the memory needs of the
7777
extension module. Even when the requested memory is used exclusively for
78-
internal, highly-specific purposes, delegating all memory requests to the Python
78+
internal, highly specific purposes, delegating all memory requests to the Python
7979
memory manager causes the interpreter to have a more accurate image of its
8080
memory footprint as a whole. Consequently, under certain circumstances, the
8181
Python memory manager may or may not trigger appropriate actions, like garbage

Doc/c-api/typeobj.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ type objects) *must* have the :attr:`ob_size` field.
529529
``PyObject_HEAD_INIT`` macro. For :ref:`statically allocated objects
530530
<static-types>`, these fields always remain ``NULL``. For :ref:`dynamically
531531
allocated objects <heap-types>`, these two fields are used to link the
532-
object into a doubly-linked list of *all* live objects on the heap.
532+
object into a doubly linked list of *all* live objects on the heap.
533533

534534
This could be used for various debugging purposes; currently the only uses
535535
are the :func:`sys.getobjects` function and to print the objects that are

Doc/c-api/weakref.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ as much as it can.
3535
callable object that receives notification when *ob* is garbage collected; it
3636
should accept a single parameter, which will be the weak reference object
3737
itself. *callback* may also be ``None`` or ``NULL``. If *ob* is not a
38-
weakly-referencable object, or if *callback* is not callable, ``None``, or
38+
weakly referencable object, or if *callback* is not callable, ``None``, or
3939
``NULL``, this will return ``NULL`` and raise :exc:`TypeError`.
4040
4141
@@ -47,7 +47,7 @@ as much as it can.
4747
be a callable object that receives notification when *ob* is garbage
4848
collected; it should accept a single parameter, which will be the weak
4949
reference object itself. *callback* may also be ``None`` or ``NULL``. If *ob*
50-
is not a weakly-referencable object, or if *callback* is not callable,
50+
is not a weakly referencable object, or if *callback* is not callable,
5151
``None``, or ``NULL``, this will return ``NULL`` and raise :exc:`TypeError`.
5252
5353

Doc/distutils/apiref.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1198,7 +1198,7 @@ other utility module.
11981198
it contains certain values: see :func:`check_environ`. Raise :exc:`ValueError`
11991199
for any variables not found in either *local_vars* or ``os.environ``.
12001200

1201-
Note that this is not a fully-fledged string interpolation function. A valid
1201+
Note that this is not a full-fledged string interpolation function. A valid
12021202
``$variable`` can consist only of upper and lower case letters, numbers and an
12031203
underscore. No { } or ( ) style quoting is available.
12041204

Doc/extending/building.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The initialization function has the signature:
1717

1818
.. c:function:: PyObject* PyInit_modulename(void)
1919
20-
It returns either a fully-initialized module, or a :c:type:`PyModuleDef`
20+
It returns either a fully initialized module, or a :c:type:`PyModuleDef`
2121
instance. See :ref:`initializing-modules` for details.
2222
2323
.. highlight:: python

Doc/extending/newtypes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ example::
175175
}
176176

177177
If no :c:member:`~PyTypeObject.tp_repr` handler is specified, the interpreter will supply a
178-
representation that uses the type's :c:member:`~PyTypeObject.tp_name` and a uniquely-identifying
178+
representation that uses the type's :c:member:`~PyTypeObject.tp_name` and a uniquely identifying
179179
value for the object.
180180

181181
The :c:member:`~PyTypeObject.tp_str` handler is to :func:`str` what the :c:member:`~PyTypeObject.tp_repr` handler
@@ -589,7 +589,7 @@ with the required field::
589589
PyObject *weakreflist; /* List of weak references */
590590
} TrivialObject;
591591

592-
And the corresponding member in the statically-declared type object::
592+
And the corresponding member in the statically declared type object::
593593

594594
static PyTypeObject TrivialType = {
595595
PyVarObject_HEAD_INIT(NULL, 0)

Doc/faq/design.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ you're too lazy to define a function.
313313

314314
Functions are already first class objects in Python, and can be declared in a
315315
local scope. Therefore the only advantage of using a lambda instead of a
316-
locally-defined function is that you don't need to invent a name for the
316+
locally defined function is that you don't need to invent a name for the
317317
function -- but that's just a local variable to which the function object (which
318318
is exactly the same type of object that a lambda expression yields) is assigned!
319319

Doc/faq/programming.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ It's good practice if you import modules in the following order:
294294
1. standard library modules -- e.g. ``sys``, ``os``, ``getopt``, ``re``
295295
2. third-party library modules (anything installed in Python's site-packages
296296
directory) -- e.g. mx.DateTime, ZODB, PIL.Image, etc.
297-
3. locally-developed modules
297+
3. locally developed modules
298298

299299
It is sometimes necessary to move imports to a function or class to avoid
300300
problems with circular imports. Gordon McMillan says:
@@ -771,7 +771,7 @@ What does the slash(/) in the parameter list of a function mean?
771771

772772
A slash in the argument list of a function denotes that the parameters prior to
773773
it are positional-only. Positional-only parameters are the ones without an
774-
externally-usable name. Upon calling a function that accepts positional-only
774+
externally usable name. Upon calling a function that accepts positional-only
775775
parameters, arguments are mapped to parameters based solely on their position.
776776
For example, :func:`divmod` is a function that accepts positional-only
777777
parameters. Its documentation looks like this::

0 commit comments

Comments
 (0)