Skip to content

Commit 4d3ef3e

Browse files
authored
gh-1178: Fix indentation in a few more pages (#1181)
1 parent 43fad8f commit 4d3ef3e

File tree

4 files changed

+26
-25
lines changed

4 files changed

+26
-25
lines changed

getting-started/pull-request-lifecycle.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,15 @@ should do to help ensure that your pull request is accepted.
241241
``patchcheck`` is a simple automated patch checklist that guides a developer
242242
through the common patch generation checks. To run ``patchcheck``:
243243

244-
On *Unix* (including macOS)::
244+
On *Unix* (including macOS)::
245245

246-
make patchcheck
246+
make patchcheck
247247

248-
On *Windows* (after any successful build):
248+
On *Windows* (after any successful build):
249249

250-
.. code-block:: dosbatch
250+
.. code-block:: dosbatch
251251
252-
python.bat Tools\patchcheck\patchcheck.py
252+
python.bat Tools\patchcheck\patchcheck.py
253253
254254
The automated patch checklist runs through:
255255

internals/garbage-collector.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@ class instances, classes in extension modules, etc. One could think that
131131
cycles are uncommon but the truth is that many internal references needed by
132132
the interpreter create cycles everywhere. Some notable examples:
133133

134-
* Exceptions contain traceback objects that contain a list of frames that
135-
contain the exception itself.
136-
* Module-level functions reference the module's dict (which is needed to resolve globals),
137-
which in turn contains entries for the module-level functions.
138-
* Instances have references to their class which itself references its module, and the module
139-
contains references to everything that is inside (and maybe other modules)
140-
and this can lead back to the original instance.
141-
* When representing data structures like graphs, it is very typical for them to
142-
have internal links to themselves.
134+
* Exceptions contain traceback objects that contain a list of frames that
135+
contain the exception itself.
136+
* Module-level functions reference the module's dict (which is needed to resolve globals),
137+
which in turn contains entries for the module-level functions.
138+
* Instances have references to their class which itself references its module, and the module
139+
contains references to everything that is inside (and maybe other modules)
140+
and this can lead back to the original instance.
141+
* When representing data structures like graphs, it is very typical for them to
142+
have internal links to themselves.
143143

144144
To correctly dispose of these objects once they become unreachable, they need to be
145145
identified first. Inside the function that identifies cycles, two doubly linked
@@ -417,13 +417,13 @@ word-aligned addresses end in ``000``, leaving the last 3 bits available.
417417
The CPython GC makes use of two fat pointers that correspond to the extra fields
418418
of ``PyGC_Head`` discussed in the `Memory layout and object structure`_ section:
419419

420-
.. warning::
420+
.. warning::
421421

422-
Because the presence of extra information, "tagged" or "fat" pointers cannot be
423-
dereferenced directly and the extra information must be stripped off before
424-
obtaining the real memory address. Special care needs to be taken with
425-
functions that directly manipulate the linked lists, as these functions
426-
normally assume the pointers inside the lists are in a consistent state.
422+
Because the presence of extra information, "tagged" or "fat" pointers cannot be
423+
dereferenced directly and the extra information must be stripped off before
424+
obtaining the real memory address. Special care needs to be taken with
425+
functions that directly manipulate the linked lists, as these functions
426+
normally assume the pointers inside the lists are in a consistent state.
427427

428428

429429
* The ``_gc_prev`` field is normally used as the "previous" pointer to maintain the

internals/parser.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ To activate verbose mode you can add the ``-d`` flag when executing Python:
890890
$ python -d file_to_test.py
891891
892892
This will print **a lot** of output to ``stderr`` so is probably better to dump it to a file for further analysis. The output
893-
consists of trace lines with the following structure:
893+
consists of trace lines with the following structure::
894894

895895
<indentation> ('>'|'-'|'+'|'!') <rule_name>[<token_location>]: <alternative> ...
896896

@@ -902,9 +902,10 @@ character marks the type of the trace:
902902
* ``+`` indicates that a rule has been parsed correctly.
903903
* ``!`` indicates that an exception or an error has been detected and the parser is unwinding.
904904

905-
The <token_location> part indicates the current index in the token array, the
906-
<rule_name> part indicates what rule is being parsed and the <alternative> part
907-
indicates what alternative within that rule is being attempted.
905+
The ``<token_location>`` part indicates the current index in the token array,
906+
the ``<rule_name>`` part indicates what rule is being parsed and
907+
the ``<alternative>`` part indicates what alternative within that rule
908+
is being attempted.
908909

909910

910911
References

testing/coverage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ long as your venv is activated. For more info on venv see `Virtual Environment
111111

112112
If this does not work for you for some reason, you should try using the
113113
in-development version of coverage.py to see if it has been updated as needed.
114-
To do this you should clone/check out the development version of coverage.py:
114+
To do this you should clone/check out the development version of coverage.py::
115115

116116
git clone https://github.com/nedbat/coveragepy
117117

0 commit comments

Comments
 (0)