Skip to content

Commit 2b8d823

Browse files
authored
Fix some markup (including 2 false-positives) (#957)
1 parent 1e315c0 commit 2b8d823

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

documentation/style-guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ reading experience.
151151
Instead, these security concerns should be gathered into a dedicated
152152
"Security Considerations" section within the module's documentation, and
153153
cross-referenced from the documentation of affected interfaces with a note
154-
similar to ``"Please refer to the :ref:`security-considerations` section
155-
for important information on how to avoid common mistakes."``.
154+
similar to :samp:`"Please refer to the :ref:\`{security-considerations}\`
155+
section for important information on how to avoid common mistakes."`.
156156

157157
Similarly, if there is a common error that affects many interfaces in a
158158
module (e.g. OS level pipe buffers filling up and stalling child processes),

internals/parser.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -833,9 +833,9 @@ Testing
833833

834834
There are three files that contain tests for the grammar and the parser:
835835

836-
* `Lib/test/test_grammar.py`.
837-
* `Lib/test/test_syntax.py`.
838-
* `Lib/test/test_exceptions.py`.
836+
* ``Lib/test/test_grammar.py``.
837+
* ``Lib/test/test_syntax.py``.
838+
* ``Lib/test/test_exceptions.py``.
839839

840840
Check the contents of these files to know which is the best place to place new tests depending
841841
on the nature of the new feature you are adding.

testing/coverage.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,9 @@ times.
258258

259259
Filing the Issue
260260
================
261-
Once you have increased coverage, you need to create an issue on the
262-
`issue tracker`_ and submit a :ref:`pull request <pullrequest>`.
261+
Once you have increased coverage,
262+
you need to create an issue on the `issue tracker`_ and
263+
submit a :ref:`pull request <pullrequest>`.
263264

264265

265266
Measuring coverage of C code with gcov and lcov

0 commit comments

Comments
 (0)