mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-12 11:46:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[doc]: Fix missing space in c-api/init.rst and add rstlint rule (GH-28988)

Browse source
This commit is contained in:
Julien Palard 2021-10-19 21:13:24 +02:00 • committed by GitHub
parent 975b94b9de
commit bda69abe84
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/c-api/init.rst
View file

@ -1177,7 +1177,7 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
Suspend tracing and profiling in the Python thread state *tstate*. Suspend tracing and profiling in the Python thread state *tstate*.
Resume them using the:c:func:`PyThreadState_LeaveTracing` function. Resume them using the :c:func:`PyThreadState_LeaveTracing` function.
.. versionadded:: 3.11 .. versionadded:: 3.11
@ -1185,7 +1185,7 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
.. c:function:: void PyThreadState_LeaveTracing(PyThreadState *tstate) .. c:function:: void PyThreadState_LeaveTracing(PyThreadState *tstate)
Resume tracing and profiling in the Python thread state *tstate* suspended Resume tracing and profiling in the Python thread state *tstate* suspended
by the:c:func:`PyThreadState_EnterTracing` function. by the :c:func:`PyThreadState_EnterTracing` function.
See also :c:func:`PyEval_SetTrace` and :c:func:`PyEval_SetProfile` See also :c:func:`PyEval_SetTrace` and :c:func:`PyEval_SetProfile`
functions. functions.

17
Doc/tools/rstlint.py
View file

@ -43,10 +43,10 @@ directives = [
] ]
roles = [ roles = [
":class:", "(?<!py):class:",
":func:", "(?<!:c|py):func:",
":meth:", "(?<!py):meth:",
":mod:", "(?<!:py):mod:",
":exc:", ":exc:",
":issue:", ":issue:",
":attr:", ":attr:",
@ -54,7 +54,7 @@ roles = [
":ref:", ":ref:",
":const:", ":const:",
":term:", ":term:",
":data:", "(?<!:c|py):data:",
":keyword:", ":keyword:",
":file:", ":file:",
":pep:", ":pep:",
@ -128,6 +128,11 @@ double_backtick_role = re.compile(r"(?<!``)%s``" % all_roles)
# :const:`None` # :const:`None`
role_with_no_backticks = re.compile(r"%s[^` ]" % all_roles) role_with_no_backticks = re.compile(r"%s[^` ]" % all_roles)
# Find role glued with another word like:
# the:c:func:`PyThreadState_LeaveTracing` function.
# instad of:
# the :c:func:`PyThreadState_LeaveTracing` function.
role_glued_with_word = re.compile(r"[a-zA-Z]%s" % all_roles)
default_role_re = re.compile(r"(^| )`\w([^`]*?\w)?`($| )") default_role_re = re.compile(r"(^| )`\w([^`]*?\w)?`($| )")
leaked_markup_re = re.compile(r"[a-z]::\s|`|\.\.\s*\w+:") leaked_markup_re = re.compile(r"[a-z]::\s|`|\.\.\s*\w+:")
@ -176,6 +181,8 @@ def check_suspicious_constructs(fn, lines):
yield lno, "role use a single backtick, double backtick found." yield lno, "role use a single backtick, double backtick found."
if role_with_no_backticks.search(line): if role_with_no_backticks.search(line):
yield lno, "role use a single backtick, no backtick found." yield lno, "role use a single backtick, no backtick found."
if role_glued_with_word.search(line):
yield lno, "missing space before role"
if ".. productionlist::" in line: if ".. productionlist::" in line:
inprod = True inprod = True
elif not inprod and default_role_re.search(line): elif not inprod and default_role_re.search(line):