◐ Shell
reader mode source ↗
Skip to content

bpo-29086: Add stableabi option to Documentation#23185

Closed
WillAyd wants to merge 2 commits into
python:masterfrom
WillAyd:limited-doc-updates
Closed

bpo-29086: Add stableabi option to Documentation#23185
WillAyd wants to merge 2 commits into
python:masterfrom
WillAyd:limited-doc-updates

Conversation

@WillAyd

@WillAyd WillAyd commented Nov 6, 2020 •
edited by miss-islington
Loading

Copy link
Copy Markdown
Contributor

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

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Nov 6, 2020
@WillAyd

WillAyd commented Nov 6, 2020

Copy link
Copy Markdown
Contributor Author

This is how it renders:

image

Fidget-Spinner
Fidget-Spinner reviewed Nov 7, 2020
View reviewed changes

@Fidget-Spinner Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide 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).

@WillAyd WillAyd marked this pull request as ready for review November 10, 2020 18:51
@github-actions

github-actions Bot commented Dec 16, 2020

Copy link
Copy Markdown

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

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Dec 16, 2020
@WillAyd

WillAyd commented Dec 16, 2020

Copy link
Copy Markdown
Contributor Author

Not stale just awaiting core review

Mariatta
Mariatta approved these changes Dec 16, 2020
View reviewed changes

@Mariatta Mariatta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Looks great to me. Thanks!

@Mariatta

Mariatta commented Dec 16, 2020

Copy link
Copy Markdown
Member

Does this need backport?

@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Dec 17, 2020
@WillAyd

WillAyd commented Dec 17, 2020

Copy link
Copy Markdown
Contributor Author

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

@encukou

encukou commented Dec 31, 2020

Copy link
Copy Markdown
Member

Hi,
Can we please hold off on this PR for a few weeks? I am writing a PEP about the stable ABI.

@Mariatta

Mariatta commented Dec 31, 2020

Copy link
Copy Markdown
Member

No prob, @encukou .I've added the do-not-merge label for now.

@encukou

encukou commented Dec 31, 2020

Copy link
Copy Markdown
Member

I've just put up a first draft of the PEP at: https://github.com/encukou/abi3/blob/main/PEP.rst
and kicked off a discussion at: https://mail.python.org/archives/list/capi-sig@python.org/thread/PMM5QG4IAL6LOMNFXNHW72INSCN4JC5H/

@github-actions

github-actions Bot commented Feb 2, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Feb 2, 2021
@encukou

encukou commented Feb 2, 2021

Copy link
Copy Markdown
Member

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?

@encukou encukou removed the stale Stale PR or inactive for long period of time. label Feb 2, 2021
@WillAyd

WillAyd commented Feb 2, 2021 via email

Copy link
Copy Markdown
Contributor Author

@encukou encukou closed this Feb 2, 2021
encukou added a commit to encukou/cpython that referenced this pull request Apr 29, 2021
@encukou @WillAyd
Add "Part of the Stable ABI" annotations to the documentation …
179c132 
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 <william.ayd@icloud.com>
@encukou

encukou commented Apr 29, 2021

Copy link
Copy Markdown
Member

GH-25668 proposes to add the notes, along with when a particular API was added.

@WillAyd WillAyd deleted the limited-doc-updates branch November 6, 2022 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mariatta Mariatta

@Fidget-Spinner Fidget-Spinner

@abalkin abalkin Awaiting requested review from abalkin

@pganssle pganssle Awaiting requested review from pganssle

Assignees

No one assigned

Labels

awaiting merge DO-NOT-MERGE docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@WillAyd @Mariatta @encukou @Fidget-Spinner @bedevere-bot