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

[3.11] gh-102304: doc: Add links to Stable ABI and Limited C API (#105345) (#105371) #109901

Merged
merged 2 commits into from
Sep 29, 2023

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Sep 26, 2023

(cherry picked from commit bae415a)

(cherry picked from commit 0202aa0) (cherry picked from commit 82ab13c)


These targets were added for 3.13 and 3.12, but they're needed for the devguide: python/devguide#1167

A


📚 Documentation preview 📚: https://cpython-previews--109901.org.readthedocs.build/

python#105345) (python#105371)

* pythongh-102304: doc: Add links to Stable ABI and Limited C API (python#105345)

* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:

  - Lib/test/test_stable_abi_ctypes.py
  - PC/python3dll.c

(cherry picked from commit bae415a)

* pythongh-102304: Fix up Simple ABI doc (pythonGH-105351)

(cherry picked from commit 0202aa0)
(cherry picked from commit 82ab13c)
@AA-Turner AA-Turner force-pushed the backport-82ab13c-3.11 branch from 967be20 to e4154d4 Compare September 26, 2023 12:54
@erlend-aasland
Copy link
Contributor

Unfortunately, bae415a does a lot of things:

  • doc updates
  • C source updates
  • script updates

AFAICS, only the doc updates are relevant for python/devguide#1167? @vstinner, should the whole commit be backported, or only parts of it?

@vstinner
Copy link
Member

It's up to you, I don't know. I understood that the doc should look the same in all branches: all doc changes should be backported.

@AA-Turner
Copy link
Member Author

should the whole commit be backported, or only parts of it?

I'd intended to only backport the documentation changes; something went wrong in preparing this PR. But if we want to backport everything happy to update the PR, I just wanted to err on the cautious side.

A

@erlend-aasland
Copy link
Contributor

It's up to you, I don't know. I understood that the doc should look the same in all branches: all doc changes should be backported.

The problem is that the original commit is not a doc change; it changes a lot of non-doc stuff.

@erlend-aasland
Copy link
Contributor

@AA-Turner, could you write comment that sums up this change (for the merge commit message)?

@AA-Turner
Copy link
Member Author

First draft:


Add links to the Stable ABI and Limited C API

  • Add "limited-c-api" and "stable-api" targets
  • Rename the "stable-abi-list" target to "limited-api-list"

A

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM

@erlend-aasland
Copy link
Contributor

First draft:

Looks ok to me!

@erlend-aasland erlend-aasland merged commit d81bcc2 into python:3.11 Sep 29, 2023
18 checks passed
@AA-Turner AA-Turner deleted the backport-82ab13c-3.11 branch January 13, 2024 20:28
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.

3 participants