Skip to content

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

Merged
ethanfurman merged 4 commits into
python:mainfrom
ethanfurman:enum-whatsnew
Oct 21, 2022
Merged

gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values#98455
ethanfurman merged 4 commits into
python:mainfrom
ethanfurman:enum-whatsnew

Conversation

@ethanfurman

@ethanfurmanethanfurman commented Oct 19, 2022•
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

@ethanfurmanethanfurman removed docs Documentation in the Doc dir awaiting core review labels Oct 19, 2022
@ethanfurman

ethanfurman commented Oct 19, 2022

Copy link
Copy Markdown
MemberAuthor

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

@CAM-GerlachCAM-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
CAM-Gerlach
CAM-Gerlach reviewed Oct 19, 2022
View reviewed changes

@CAM-GerlachCAM-Gerlach 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.

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!

Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 19, 2022
Closed
33 tasks
CAM-Gerlach
CAM-Gerlach reviewed Oct 21, 2022
View reviewed changes

@CAM-GerlachCAM-Gerlach left a comment •
edited
Loading

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.

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.

Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
Comment threadDoc/library/enum.rst Outdated
@ethanfurman@CAM-Gerlach
Apply suggestions from code review
5fabc78
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@ethanfurman

ethanfurman commented Oct 21, 2022

Copy link
Copy Markdown
MemberAuthor

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

@ethanfurmanethanfurman self-assigned this Oct 21, 2022
@ethanfurman
ethanfurman merged commit 3e95ffc into python:mainOct 21, 2022
@miss-islington

miss-islington commented Oct 21, 2022

Copy link
Copy Markdown
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
@ethanfurman@miss-islington
pythongh-98298: [Enum] document ReprEnum, global_enum, and show_flag_…
bcf4fca
…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

bedevere-bot commented Oct 21, 2022

Copy link
Copy Markdown

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

@bedevere-botbedevere-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
@miss-islington@ethanfurman
gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values (…
31d23ae
…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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CAM-GerlachCAM-GerlachAwaiting requested review from CAM-Gerlach

Assignees

@ethanfurmanethanfurman

Labels

3.11only security fixesdocsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ethanfurman@miss-islington@bedevere-bot@CAM-Gerlach