GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-95913: Copyedit, xref and organize enum section by CAM-Gerlach · Pull Request #98295 · python/cpython

Conversation

@CAM-Gerlach

@CAM-Gerlach CAM-Gerlach commented Oct 15, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Part of #95913 . Also intends to solve #98250 (which I hadn't seen when I first created this).

Initially, this started out as a PR adding the missing new enum APIs, but I pulled that out to a separate issue, # , and keeping this one focused on just the copyediting, cross-referencing and organization of the section, which ended up being fairly extensive.

In particular, this PR:

  • Describes the changes to __format__ and __str__ changes more clearly and comprehensively, per Enum.__str__ change could be improved in What's New #98250 (and superseding gh-98250: Improve documentation about change to Enum.__format__ #98261 )
  • Converts the code literals in the exiting enum sections to actual Sphinx cross-references to the various items discussed (a few of which didn't resolved, which highlighted that several new APIs mentioned here weren't actually documented)
  • Rewrites the section's phrasing to be consistent with the others, namely past-tense prose
  • More clearly and descriptively explains several of the new features whose items were potentially confusing or incomplete
  • Combines closely related elements which had distinct bullets, sometimes widely separated, to avoid duplication and be easier to follow
  • Applies other Sphinx syntax and semantics, and fixes other minor textual issues

Closes #98250

  • Issue: Edit What's New for Python 3.11 #95913

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
CAM-Gerlach added 3 commits October 15, 2022 13:40
@CAM-Gerlach
Whatsnew: Convert literals in enum section to actual x-references
2e15caa
@CAM-Gerlach
Whatsnew: Rewrite enum section for clear and consistant phrasing
9a61957
@CAM-Gerlach
Whatsnew: Combine directly related enum items instead of seperating them
1ddd452
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 15, 2022
@CAM-Gerlach
CAM-Gerlach requested review from ethanfurman and ezio-melotti October 15, 2022 20:41
@CAM-Gerlach CAM-Gerlach changed the title Whatsnew: Copyedit, xref and organize enum section gh-95913: Copyedit, xref and organize enum section Oct 15, 2022
@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 15, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 15, 2022
Document new 3.11 enum APIs (ReprEnum, global_* and/or show_flag_values) #98298
Closed
@CAM-Gerlach

CAM-Gerlach commented Oct 15, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

Related to, and provided the impetus for, #98298
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 15, 2022
Edit What's New for Python 3.11 #95913
Closed
31 of 33 tasks
@CAM-Gerlach
pythongh-98250: Describe __str__/__format__ changes more clearly/accu…
a596720 
…rately
@CAM-Gerlach

CAM-Gerlach commented Oct 15, 2022

Copy link
Copy Markdown
Member Author

I've added some additional explanations and clarifications to further address the issue brought up in issue #98250 and incorporate the spirit of the change in PR #98261 , which I missed seeing before I submitted this PR.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
This was referenced Oct 15, 2022
gh-98250: Improve documentation about change to Enum.__format__ #98261
Closed
Enum.__str__ change could be improved in What's New #98250
Closed
mdboom
mdboom approved these changes Oct 17, 2022
View reviewed changes

@mdboom mdboom left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting core review and removed awaiting review labels Oct 17, 2022
ethanfurman
ethanfurman requested changes Oct 17, 2022
View reviewed changes

@ethanfurman ethanfurman left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks for fixing that. One change and one suggestion. :-)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach reacted with hooray emoji
All reactions
  • 🎉 1 reaction
Comment thread Doc/whatsnew/3.11.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/whatsnew/3.11.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting core review label Oct 17, 2022
@bedevere-bot

bedevere-bot commented Oct 17, 2022

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added the awaiting changes label Oct 17, 2022
@CAM-Gerlach
Tweak enum section language per feedback from Ethan
9d2486e
@CAM-Gerlach
CAM-Gerlach requested review from ethanfurman and mdboom October 17, 2022 17:31
ethanfurman
ethanfurman approved these changes Oct 17, 2022
View reviewed changes
@bedevere-bot bedevere-bot removed the awaiting changes label Oct 17, 2022
@bedevere-bot bedevere-bot added the awaiting merge label Oct 17, 2022
ezio-melotti
ezio-melotti approved these changes Oct 18, 2022
View reviewed changes
@ezio-melotti
ezio-melotti merged commit 73e5180 into python:main Oct 18, 2022
@miss-islington

miss-islington commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

Thanks @CAM-Gerlach for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting merge label Oct 18, 2022
@bedevere-bot

bedevere-bot commented Oct 18, 2022

Copy link
Copy Markdown

GH-98386 is a backport of this pull request to the 3.11 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 18, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 18, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Copyedit, xref and organize enum section (pythonGH-98295
7f8ca17 
)

* Whatsnew: Convert literals in enum section to actual x-references

* Whatsnew: Rewrite enum section for clear and consistant phrasing

* Whatsnew: Combine directly related enum items instead of seperating them

* pythongh-98250: Describe __str__/__format__ changes more clearly/accurately

* Tweak enum section language per feedback from Ethan
(cherry picked from commit 73e5180)

Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington added a commit that referenced this pull request Oct 18, 2022
@miss-islington @CAM-Gerlach
gh-95913: Copyedit, xref and organize enum section (GH-98295)
d798b59 
* Whatsnew: Convert literals in enum section to actual x-references

* Whatsnew: Rewrite enum section for clear and consistant phrasing

* Whatsnew: Combine directly related enum items instead of seperating them

* gh-98250: Describe __str__/__format__ changes more clearly/accurately

* Tweak enum section language per feedback from Ethan
(cherry picked from commit 73e5180)

Co-authored-by: C.A.M. Gerlach <[email protected]>
@CAM-Gerlach

CAM-Gerlach commented Oct 19, 2022

Copy link
Copy Markdown
Member Author

BTW @ethanfurman , I hate to bug you but since we're on a tight timetable for the 3.11 release, do you think you could share your thoughts on #98298 ? I can take care of adding the mentioned docs if needed (with your review), but I wanted to get your take first as the resident Enum expert and the author of most of the changes being documented. Thanks!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @CAM-Gerlach @pablogsal
gh-95913: Copyedit, xref and organize enum section (GH-98295)
1f192c3 
* Whatsnew: Convert literals in enum section to actual x-references

* Whatsnew: Rewrite enum section for clear and consistant phrasing

* Whatsnew: Combine directly related enum items instead of seperating them

* gh-98250: Describe __str__/__format__ changes more clearly/accurately

* Tweak enum section language per feedback from Ethan
(cherry picked from commit 73e5180)

Co-authored-by: C.A.M. Gerlach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ethanfurman ethanfurman ethanfurman approved these changes
@ezio-melotti ezio-melotti ezio-melotti approved these changes
@mdboom mdboom Awaiting requested review from mdboom

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

3.11 only security fixes docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Enum.__str__ change could be improved in What's New

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@CAM-Gerlach @bedevere-bot @miss-islington @mdboom @ethanfurman @ezio-melotti
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.