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

Plural vs Singular in enum documentation #104659

Closed
twmr opened this issue May 19, 2023 · 2 comments · Fixed by #104665
Closed

Plural vs Singular in enum documentation #104659

twmr opened this issue May 19, 2023 · 2 comments · Fixed by #104665
Assignees
@ethanfurman
Labels
docs Documentation in the Doc dir

Comments

@twmr
Copy link
Contributor

twmr commented May 19, 2023 •
edited by bedevere-bot
Loading

Documentation

Hi! I've just seen that classname in the example in the documentation for IntEnum (https://docs.python.org/3/library/enum.html#enum.IntEnum) is in the plural (Numbers) but for all the other enum examples a classname in the singular is used.

Since a singluar classname IMO makes more sense for all enum classes, I think Numbers should be changed to Number in the documentation.

Linked PRs
@twmr twmr added the docs Documentation in the Doc dir label May 19, 2023
@ethanfurman
Copy link
Member

@Thisch You are correct. Do you want to create a PR?

@twmr
Copy link
Contributor Author

twmr commented May 19, 2023

@ethanfurman Sure, I'll create a PR.

twmr added a commit to twmr/cpython that referenced this issue May 19, 2023
@twmr
Consolidate python examples in enum documentaiton
b37de8e 
The InteEnum example in the docs is the only example where a plural
classname is used (Numbers). This commit fixes it by renaming Numbers
to Number.

Closes python#104659
twmr added a commit to twmr/cpython that referenced this issue May 19, 2023
@twmr
Consolidate python examples in enum documentaiton
f44938d 
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

Change-Id: I28557ceac96b3dc9606415b0426a34906b7d3744
twmr added a commit to twmr/cpython that referenced this issue May 19, 2023
@twmr
Consolidate python examples in enum documentaiton
e7c0205 
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 mentioned this issue May 19, 2023
Merged
twmr added a commit to twmr/cpython that referenced this issue May 19, 2023
@twmr
Consolidate python examples in enum documentaiton
90b8bb0 
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 added a commit to twmr/cpython that referenced this issue 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
hugovk pushed a commit that referenced this issue May 19, 2023
@twmr
gh-104659: Consolidate python examples in enum documentation (#104665)
3ac856e
@bedevere-bot bedevere-bot mentioned this issue May 19, 2023
Merged
hugovk pushed a commit to hugovk/cpython that referenced this issue May 19, 2023
@twmr @hugovk
pythongh-104659: Consolidate python examples in enum documentation (p…
cc7d2bf 
…ython#104665)

(cherry picked from commit 3ac856e)
hugovk added a commit that referenced this issue 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 <[email protected]>
carljm added a commit to gsallam/cpython_with_perfmap_apii that referenced this issue 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)
  ...
@Bobronium Bobronium mentioned this issue Sep 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ethanfurman ethanfurman

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

Successfully merging a pull request may close this issue.

gh-104659: Consolidate python examples in enum documentation twmr/cpython
2 participants
@twmr @ethanfurman