FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-104659: Consolidate python examples in enum documentation by twmr · Pull Request #104665 · python/cpython · GitHub

/ cpython Public

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 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/

ghost commented May 19, 2023
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

twmr changed the title gh-104659: Consolidate python examples in enum documentaiton gh-104659: Consolidate python examples in enum documentation May 19, 2023
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 force-pushed the singular_enum branch 2 times, most recently from 90b8bb0 to 79ff9b2 Compare May 19, 2023 16:56
hugovk added the needs backport to 3.11 only security fixes label May 19, 2023
hugovk merged commit 3ac856e into python:main 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!

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

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).

Copy link
Copy Markdown

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

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

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
…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
* 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)
  ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Plural vs Singular in enum documentation

6 participants


Back | FazBrowse Home | New Git URL