bpo-29086: Add stableabi option to Documentation #23185
Conversation
|
This is how it renders:
|
There was a problem hiding this comment.
This LGTM, the only problem is that nearly all the :stableabi: markup has trailing whitespace and tabs, this is causing both the Travis CI checks and Azure pipelines to fail.
Usually I'd advise running make patcheck. However, you might want to do this using your own IDE/manually since it occasionally re-indents/de-indents unrelated parts of the documentation (from personal experience).
|
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days |
|
Not stale just awaiting core review |
|
Does this need backport? |
github-actions
bot
removed
the
stale
|
Not sure what your backport policy is. It could be since it has been this way for a while, though at the same time the change is relatively minor |
Mariatta
added
needs backport to 3.8
needs backport to 3.9
|
Hi, |
|
No prob, @encukou .I've added the do-not-merge label for now. |
|
I've just put up a first draft of the PEP at: https://github.com/encukou/abi3/blob/main/PEP.rst |
|
This PR is stale because it has been open for 30 days with no activity. |
|
The PEP is almost ready: https://discuss.python.org/t/pre-pep-maintaining-the-stable-abi/6986 @WillAyd, do you mind if I close this PR and take over the effort? |
|
Not a problem at all - great work on the PEP
…Sent from my iPhone
On Feb 2, 2021, at 1:42 PM, Petr Viktorin ***@***.***> wrote:
The PEP is almost ready: https://discuss.python.org/t/pre-pep-maintaining-the-stable-abi/6986
@WillAyd, do you mind if I close this PR and take over the effort?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
This replaces the existing :stableabi:, which wasn't really used. Doc/data/stable_abi.dat is expanded to include all relevant info (kind of the symbol and version it was added in), and the c_annotations Sphinx extension reads this file and adds notes similar to ones added by :stableabi: (which wasn't really used). Relevant prior work: python#23185 Co-authored-by: Will Ayd <[email protected]>
|
GH-25668 proposes to add the notes, along with when a particular API was added. |
Starting as a draft for now, as there are quite a few ways to go about this. I figured this first approach, while verbose, has the upside of leveraging functionality that has already been built into the documentation. Happy to expand to other functions if we think this is in the right direction
https://bugs.python.org/issue29086