Skip to content

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

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
lysnikolaou merged 1 commit into from
Mar 19, 2026
Merged

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

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
gh-145254: Fix formatting of thread safety annotations 
- 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.
  • Loading branch information
@lysnikolaou
lysnikolaou committed Mar 18, 2026
commit 01b9e9ef60cf9833ccd144dca566b71818673397
16 changes: 9 additions & 7 deletions Doc/tools/extensions/c_annotations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}")
Expand All @@ -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:
Expand Down
Loading