mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[3.11] GH-101986: Support translation for Limited/Unstable API & Stable ABI (GH-107680) (#112941) 

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
This commit is contained in:
Hugo van Kemenade 2023-12-10 21:28:10 +02:00 committed by GitHub
parent 95f5c8c46c
commit 2f2668391c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/tools/extensions/c_annotations.py
View File

@ -126,7 +126,7 @@ def add_annotations(self, app, doctree):
f"Object type mismatch in limited API annotation "
f"for {name}: {record['role']!r} != {objtype!r}")
stable_added = record['added']
message = ' Part of the '
message = sphinx_gettext(' Part of the ')
emph_node = nodes.emphasis(message, message,
classes=['stableabi'])
ref_node = addnodes.pending_xref(
@ -134,25 +134,25 @@ def add_annotations(self, app, doctree):
reftype='ref', refexplicit="False")
struct_abi_kind = record['struct_abi_kind']
if struct_abi_kind in {'opaque', 'members'}:
ref_node += nodes.Text('Limited API')
ref_node += nodes.Text(sphinx_gettext('Limited API'))
else:
ref_node += nodes.Text('Stable ABI')
ref_node += nodes.Text(sphinx_gettext('Stable ABI'))
emph_node += ref_node
if struct_abi_kind == 'opaque':
emph_node += nodes.Text(' (as an opaque struct)')
emph_node += nodes.Text(sphinx_gettext(' (as an opaque struct)'))
elif struct_abi_kind == 'full-abi':
emph_node += nodes.Text(' (including all members)')
emph_node += nodes.Text(sphinx_gettext(' (including all members)'))
if record['ifdef_note']:
emph_node += nodes.Text(' ' + record['ifdef_note'])
if stable_added == '3.2':
# Stable ABI was introduced in 3.2.
pass
else:
emph_node += nodes.Text(f' since version {stable_added}')
emph_node += nodes.Text(sphinx_gettext(' since version %s') % stable_added)
emph_node += nodes.Text('.')
if struct_abi_kind == 'members':
emph_node += nodes.Text(
' (Only some members are part of the stable ABI.)')
sphinx_gettext(' (Only some members are part of the stable ABI.)'))
node.insert(0, emph_node)
# Return value annotation

7
Doc/tools/templates/dummy.html
View File

@ -9,6 +9,13 @@
In extensions/c_annotations.py:
{% trans %} Part of the {% endtrans %}
{% trans %}Limited API{% endtrans %}
{% trans %}Stable ABI{% endtrans %}
{% trans %} (as an opaque struct){% endtrans %}
{% trans %} (including all members){% endtrans %}
{% trans %} since version %s{% endtrans %}
{% trans %} (Only some members are part of the stable ABI.){% endtrans %}
{% trans %}Return value: Always NULL.{% endtrans %}
{% trans %}Return value: New reference.{% endtrans %}
{% trans %}Return value: Borrowed reference.{% endtrans %}