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

bpo-43795: Document stable_abi.txt format and contents #29956

Merged
merged 3 commits into from
Dec 10, 2021

Conversation

encukou
Copy link
Member

@encukou encukou commented Dec 7, 2021

@encukou
Copy link
Member Author

encukou commented Dec 7, 2021

@gvanrossum, is this the comment you were looking for?

@tiran
Copy link
Member

tiran commented Dec 7, 2021

Petr, it would be helpful to explain under which circumstances an entry can be removed -- or that entries cannot be removed, even private _Py APIs.

@encukou
Copy link
Member Author

encukou commented Dec 7, 2021

That's a good idea, but IMO this comment should focus on the specifics of the stable_abi.txt file. So I added a link to the devguide, and I propose a new section there: python/devguide#778

@gvanrossum
Copy link
Member

That's a good idea, but IMO this comment should focus on the specifics of the stable_abi.txt file. So I added a link to the devguide, and I propose a new section there: python/devguide#778

Actually I think it should be stated here, in this file, as well. It is much more directly useful here.

@encukou
Copy link
Member Author

encukou commented Dec 8, 2021

I summarized this as "Removing items from this file is generally not allowed, and additions should be considered with that in mind. See the devguide for exact rules."
Otherwise there'd be two fairly complex documents to keep in sync. Or it could all be moved to this file, but I think devguide is a better place.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM.

@ambv ambv merged commit 98e506a into python:main Dec 10, 2021
@encukou encukou deleted the document-stable_abi.txt branch December 14, 2021 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants