Skip to content

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

Merged
hugovk merged 1 commit into
python:mainfrom
twmr:singular_enum
May 19, 2023
Merged

gh-104659: Consolidate python examples in enum documentation#104665
hugovk merged 1 commit into
python:mainfrom
twmr:singular_enum

Conversation

@twmr

@twmrtwmr commented May 19, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

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 ownerMay 19, 2023 16:52
@bedevere-botbedevere-bot mentioned this pull request May 19, 2023
Closed
@bedevere-botbedevere-bot added docs Documentation in the Doc dir skip news labels May 19, 2023
@ghost

ghost commented May 19, 2023•
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@twmrtwmr changed the title gh-104659: Consolidate python examples in enum documentaitongh-104659: Consolidate python examples in enum documentationMay 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.
Closespython#104659
@twmr
twmrforce-pushed the singular_enum branch 2 times, most recently from 90b8bb0 to 79ff9b2CompareMay 19, 2023 16:56
@hugovkhugovk added the needs backport to 3.11 only security fixes label May 19, 2023
@hugovk
hugovk merged commit 3ac856e into python:mainMay 19, 2023
@miss-islington

miss-islington commented May 19, 2023

Copy link
Copy Markdown
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

miss-islington commented May 19, 2023

Copy link
Copy Markdown
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

sunmy2019 commented May 19, 2023

Copy link
Copy Markdown
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

bedevere-bot commented May 19, 2023

Copy link
Copy Markdown

GH-104666 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 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

hugovk commented May 19, 2023

Copy link
Copy Markdown
Member

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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes
@ethanfurmanethanfurmanethanfurman approved these changes

Assignees

@hugovkhugovk

Labels

docsDocumentation in the Doc dirskip 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