Skip to content

gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values #98455

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 4 commits into from
Oct 21, 2022

Conversation

ethanfurman
Copy link
Member

@ethanfurman ethanfurman commented Oct 19, 2022

@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Oct 19, 2022
@ethanfurman ethanfurman removed docs Documentation in the Doc dir awaiting core review labels Oct 19, 2022
@ethanfurman
Copy link
Member Author

@CAM-Gerlach ReprEnum, global_enum, and show_flag_values added to documentation. Please fix any formatting issues, etc., and feel free to merge.

@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes docs Documentation in the Doc dir labels Oct 19, 2022
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Thanks so much @ethanfurman ! I've added some suggestions for Sphinx syntax and formatting, and a couple wording clarifications on points that confused me initially as a non-enum-expert. I can't do so myself as I'm not a core dev, but you can review and apply them with just a couple clicks under Files, click Add to Batch then Commit (or revise them with your own suggestions and apply those), and then feel free to merge, assuming I didn't make any syntax typos (there isn't a direct way for me to test them locally without committing them). Thanks!

@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 19, 2022
33 tasks
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Fixes for my error-causing typo, a change not applied before and one other point of confusion I noticed with my previous revision.

Also, FYI, you can avoid having to tediously apply the changes manually by just adding the suggestions to the batch under the Files tab, and then Commit-ing them in one go—I'd hate for you to waste your valuable core dev time tediously implementing my minor fixes by hand. It will also auto-resolve the respective review suggestions, getting them out of the way.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@ethanfurman
Copy link
Member Author

@CAM-Gerlach Cool, I didn't know about the batch committing of suggestions.

@ethanfurman ethanfurman self-assigned this Oct 21, 2022
@ethanfurman ethanfurman merged commit 3e95ffc into python:main Oct 21, 2022
@miss-islington
Copy link
Contributor

Thanks @ethanfurman for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 21, 2022
…values (pythonGH-98455)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 3e95ffc)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
@bedevere-bot
Copy link

GH-98530 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 Oct 21, 2022
miss-islington added a commit that referenced this pull request Oct 21, 2022
…GH-98455)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 3e95ffc)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
@ethanfurman ethanfurman deleted the enum-whatsnew branch November 23, 2022 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants