diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index 4ebe9f4dc..f5dfe4570 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -151,8 +151,8 @@ reading experience. Instead, these security concerns should be gathered into a dedicated "Security Considerations" section within the module's documentation, and cross-referenced from the documentation of affected interfaces with a note -similar to ``"Please refer to the :ref:`security-considerations` section -for important information on how to avoid common mistakes."``. +similar to :samp:`"Please refer to the :ref:\`{security-considerations}\` +section for important information on how to avoid common mistakes."`. Similarly, if there is a common error that affects many interfaces in a module (e.g. OS level pipe buffers filling up and stalling child processes), diff --git a/internals/parser.rst b/internals/parser.rst index 951b62198..2793c77fa 100644 --- a/internals/parser.rst +++ b/internals/parser.rst @@ -833,9 +833,9 @@ Testing There are three files that contain tests for the grammar and the parser: -* `Lib/test/test_grammar.py`. -* `Lib/test/test_syntax.py`. -* `Lib/test/test_exceptions.py`. +* ``Lib/test/test_grammar.py``. +* ``Lib/test/test_syntax.py``. +* ``Lib/test/test_exceptions.py``. Check the contents of these files to know which is the best place to place new tests depending on the nature of the new feature you are adding. diff --git a/testing/coverage.rst b/testing/coverage.rst index bd143ae97..48c928993 100644 --- a/testing/coverage.rst +++ b/testing/coverage.rst @@ -258,8 +258,9 @@ times. Filing the Issue ================ -Once you have increased coverage, you need to create an issue on the -`issue tracker`_ and submit a :ref:`pull request `. +Once you have increased coverage, +you need to create an issue on the `issue tracker`_ and +submit a :ref:`pull request `. Measuring coverage of C code with gcov and lcov