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.

Sign up for GitHub

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

Jump to bottom

gh-104659: Consolidate python examples in enum documentation #104665

Merged
merged 1 commit into from May 19, 2023
Merged

gh-104659: Consolidate python examples in enum documentation #104665

merged 1 commit into from May 19, 2023

Conversation

twmr
Copy link
Contributor

@twmr twmr commented May 19, 2023 •
edited by github-actions bot

The IntEnum example in the rst docs is the only example in which a plural classname (Numbers) is used. This change fixes it by renaming Numbers to Number.

Closes #104659

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

@twmr twmr requested a review from ethanfurman as a code owner May 19, 2023 16:52
@bedevere-bot bedevere-bot mentioned this pull request May 19, 2023
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels May 19, 2023
@cpython-cla-bot
Copy link

cpython-cla-bot bot commented May 19, 2023 •
edited

All commit authors signed the Contributor License Agreement.
CLA signed

@twmr twmr changed the title gh-104659: Consolidate python examples in enum documentaiton gh-104659: Consolidate python examples in enum documentation May 19, 2023
@twmr
Consolidate python examples in enum documentation
79ff9b2 
The IntEnum example in the rst docs is the only example in which a
plural classname (Numbers) is used. This change fixes it by renaming
Numbers to Number.

Closes python#104659
@twmr twmr force-pushed the singular_enum branch 2 times, most recently from 90b8bb0 to 79ff9b2 Compare May 19, 2023 16:56
@hugovk hugovk added the needs backport to 3.11 only security fixes label May 19, 2023
@hugovk hugovk merged commit 3ac856e into python:main May 19, 2023
20 checks passed
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, @thisch and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 3ac856e69734491ff8423020c700c9ae86ac9a08 3.11

@sunmy2019
Copy link
Member

For small changes like this one, there is usually no need to force-push since they are squash merged.
For large changes, people sometimes use force-push to keep things up to date (to main).

@bedevere-bot
Copy link

GH-104666 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 May 19, 2023
hugovk pushed a commit to hugovk/cpython that referenced this pull request May 19, 2023
@twmr @hugovk
pythongh-104659: Consolidate python examples in enum documentation (p…
cc7d2bf 
…ython#104665)

(cherry picked from commit 3ac856e)
@hugovk
Copy link
Member

hugovk commented May 19, 2023

We usually prefer to avoid force-pushing to big ones too, because it makes it harder to review.

Anyway, thanks for the issue and PR!

hugovk added a commit that referenced this pull request May 19, 2023
@hugovk @twmr
[3.11] gh-104659: Consolidate python examples in enum documentation (#…
cd13f73 
…104665) (#104666)

gh-104659: Consolidate python examples in enum documentation (#104665)

(cherry picked from commit 3ac856e)

Co-authored-by: Thomas Hisch <t.hisch@gmail.com>
carljm added a commit to gsallam/cpython_with_perfmap_apii that referenced this pull request May 20, 2023
@carljm
Merge branch 'main' into gsallam/main
ea5965a 
* main: (30 commits)
  pythongh-103987: fix several crashes in mmap module (python#103990)
  docs: fix wrong indentation causing rendering error in dis page (python#104661)
  pythongh-94906: Support multiple steps in math.nextafter (python#103881)
  pythongh-104472: Skip `test_subprocess.ProcessTestCase.test_empty_env` if ASAN is enabled (python#104667)
  pythongh-103839: Allow building Tkinter against Tcl 8.7 without external libtommath (pythonGH-103842)
  pythongh-85984: New additions and improvements to the tty library. (python#101832)
  pythongh-104659: Consolidate python examples in enum documentation (python#104665)
  pythongh-92248: Deprecate `type`, `choices`, `metavar` parameters of `argparse.BooleanOptionalAction` (python#103678)
  pythongh-104645: fix error handling in marshal tests (python#104646)
  pythongh-104600: Make type.__type_params__ writable (python#104634)
  pythongh-104602: Add additional test for listcomp with lambda (python#104639)
  pythongh-104640: Disallow walrus in comprehension within type scopes (python#104641)
  pythongh-103921: Rename "type" header in argparse docs (python#104654)
  Improve readability of `typing._ProtocolMeta.__instancecheck__` (python#104649)
  pythongh-96522: Fix deadlock in pty.spawn (python#96639)
  pythonGH-102818: Do not call `PyTraceBack_Here` in sys.settrace trampoline.  (pythonGH-104579)
  pythonGH-103545: Add macOS specific constants for ``os.setpriority`` to ``os`` (python#104606)
  pythongh-104623: Update macOS installer to SQLite 3.42.0 (pythonGH-104624)
  pythongh-104619: never leak comprehension locals to outer locals() (python#104637)
  pythongh-104602: ensure all cellvars are known up front (python#104603)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@ethanfurman ethanfurman ethanfurman approved these changes

Assignees

@hugovk hugovk

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Plural vs Singular in enum documentation
6 participants
@twmr @miss-islington @sunmy2019 @bedevere-bot @hugovk @ethanfurman