Skip to content

Commit 86d41ea

Browse files
committed
Add docs for unstable API
1 parent d10dcdc commit 86d41ea

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Doc/c-api/unicode.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1952,3 +1952,22 @@ The following API is deprecated.
19521952
This API does nothing since Python 3.12.
19531953
Previously, this could be called to check if
19541954
:c:func:`PyUnicode_READY` is necessary.
1955+
1956+
1957+
Unstable API
1958+
^^^^^^^^^^^^
1959+
1960+
.. c:type:: PyUnstable_ASCIIObject
1961+
PyUnstable_CompactUnicodeObject
1962+
PyUnstable_UnicodeObject
1963+
1964+
Aliases of :c:type:`PyASCIIObject`, :c:type:`PyCompactUnicodeObject`
1965+
and :c:type:`PyUnicodeObject`.
1966+
1967+
Use these names to avoid deprecation warnings at build time,
1968+
when necessary for advanced use cases such as subclassing :py:type:`str`.
1969+
1970+
Like all unstable API, the structures may be removed in a feature release
1971+
of Python (such as 3.16.0).
1972+
Users are encouraged to test with CPython pre-releases and use CPython
1973+
development channels to discuss replacement APIs.

0 commit comments

Comments
 (0)