Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-04-14 15:50:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-145254: Fix formatting of thread safety annotations (#146111)

Browse source 
- Add leading space so that the spacing between the previous annotation
  and the thread safety annotation looks correct.
- Remove trailing period from the link to the thread safety level.
This commit is contained in:
Lysandros Nikolaou 2026-03-19 12:01:24 +01:00 • committed by GitHub
parent 89a154a0c0
commit 580043dfae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/tools/extensions/c_annotations.py
View file

@ -308,27 +308,27 @@ def _unstable_api_annotation() -> nodes.admonition:
def _threadsafety_annotation(level: str) -> nodes.emphasis:
match level:
case "incompatible":
display = sphinx_gettext("Not safe to call from multiple threads.")
display = sphinx_gettext("Not safe to call from multiple threads")
reftarget = "threadsafety-level-incompatible"
case "compatible":
display = sphinx_gettext(
"Safe to call from multiple threads"
" with external synchronization only."
" with external synchronization only"
)
reftarget = "threadsafety-level-compatible"
case "distinct":
display = sphinx_gettext(
"Safe to call without external synchronization"
" on distinct objects."
" on distinct objects"
)
reftarget = "threadsafety-level-distinct"
case "shared":
display = sphinx_gettext(
"Safe for concurrent use on the same object."
"Safe for concurrent use on the same object"
)
reftarget = "threadsafety-level-shared"
case "atomic":
display = sphinx_gettext("Atomic.")
display = sphinx_gettext("Atomic")
reftarget = "threadsafety-level-atomic"
case _:
raise AssertionError(f"Unknown thread safety level {level!r}")
@ -340,9 +340,11 @@ def _threadsafety_annotation(level: str) -> nodes.emphasis:
reftype="ref",
refexplicit="True",
)
prefix = sphinx_gettext("Thread safety:") + " "
prefix = " " + sphinx_gettext("Thread safety:") + " "
classes = ["threadsafety", f"threadsafety-{level}"]
return nodes.emphasis("", prefix, ref_node, classes=classes)
return nodes.emphasis(
"", prefix, ref_node, nodes.Text("."), classes=classes
)
def _return_value_annotation(result_refs: int | None) -> nodes.emphasis: