Skip to content

Clarify how topics.py gets created. #106121

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

Merged
merged 1 commit into from
Jul 10, 2023

Conversation

nedbat
Copy link
Member

@nedbat nedbat commented Jun 26, 2023

When changing docs, it was easy to find text in topics.py, and I wondered whether I was supposed to edit it. Thankfully, the top of the file says it's auto-generated, so I knew I didn't have to edit it. But I didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future editors.


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

When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
@JelleZijlstra
Copy link
Member

Wasn't sure about whether to backport this, but I think it's better to backport, so future bugfixes in this file don't run into conflicts.

@JelleZijlstra JelleZijlstra merged commit dac1e36 into python:main Jul 10, 2023
@miss-islington
Copy link
Contributor

Thanks @nedbat for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link

GH-106579 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 10, 2023
@bedevere-bot
Copy link

GH-106580 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 10, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 10, 2023
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36)

Co-authored-by: Ned Batchelder <[email protected]>
JelleZijlstra pushed a commit that referenced this pull request Jul 10, 2023
Clarify how topics.py gets created. (GH-106121)

When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36)

Co-authored-by: Ned Batchelder <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 10, 2023
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36)

Co-authored-by: Ned Batchelder <[email protected]>
serhiy-storchaka pushed a commit that referenced this pull request Aug 22, 2023
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36)

Co-authored-by: Ned Batchelder <[email protected]>
@nedbat nedbat deleted the nedbat/clarify-topics-py branch January 1, 2024 11:39
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.

4 participants