Skip to content
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.

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

PEP 689: Tweak a policy, add canonical-doc and Mark as Final #3123

Merged
merged 2 commits into from
May 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'packaging': ('https://packaging.python.org/en/latest/', None),
'devguide': ('https://devguide.python.org/', None),
'py3.11': ('https://docs.python.org/3.11/', None),
'py3.12': ('https://docs.python.org/3.12/', None),
}
Expand Down
9 changes: 6 additions & 3 deletions pep-0689.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 689
Title: Unstable C API tier
Author: Petr Viktorin <encukou@gmail.com>
Discussions-To: https://discuss.python.org/t/pep-689-unstable-c-api-tier/20452
Status: Accepted
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Requires: 523
Expand All @@ -13,6 +13,10 @@ Post-History: `27-Apr-2022 <https://mail.python.org/archives/list/python-dev@pyt
`27-Oct-2022 <https://discuss.python.org/t/pep-689-unstable-c-api-tier/20452>`__,
Resolution: https://discuss.python.org/t/pep-689-unstable-c-api-tier/20452/13

.. canonical-doc:: :ref:`devguide:c-api`

User-facing documentation is at :ref:`py3.12:unstable-c-api`.


Abstract
========
Expand Down Expand Up @@ -152,8 +156,7 @@ Several rules for dealing with the unstable tier will be introduced:
- To move an API from the unstable tier to the public tier, it should be
exposed without the ``PyUnstable_*`` prefix.

The old name should remain available until the first incompatible change
is made or the API is removed.
The old name should remain available until the API is deprecated or removed.

- Adding new unstable API *for existing features* is allowed even after
Beta feature freeze, up until the first Release Candidate.
Expand Down