Skip to content

Fix some markup (including 2 false-positives). #957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2022
Merged

Fix some markup (including 2 false-positives). #957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."`.
Comment on lines +154 to +155
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a workaround for one of the two false positives. It's semantically (and syntactically) valid, and solves the error reported by sphinx-lint.

It is rendered as
image
with the variable part in italic.


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),
Expand Down
6 changes: 3 additions & 3 deletions internals/parser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were actual errors.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just link the actual files (on GitHub instead)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be a good improvement for another PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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.
Expand Down
5 changes: 3 additions & 2 deletions testing/coverage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <pullrequest>`.
Once you have increased coverage,
you need to create an issue on the `issue tracker`_ and
submit a :ref:`pull request <pullrequest>`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another workaround: by reflowing the paragraph I avoid having the link and the ref on the same line.



Measuring coverage of C code with gcov and lcov
Expand Down