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

Enum Docs does MultiplesOfThree instead of PowersOfThree #100174

Closed
Beweeted opened this issue Dec 11, 2022 · 3 comments
Closed

Enum Docs does MultiplesOfThree instead of PowersOfThree #100174

Beweeted opened this issue Dec 11, 2022 · 3 comments
Assignees
@ethanfurman
Labels
docs Documentation in the Doc dir

Comments

@Beweeted
Copy link
Contributor

Beweeted commented Dec 11, 2022 •
edited by bedevere-bot
Loading

Documentation

Current:
The example includes a class PowersOfThree. Inside the function _generate_next_value_(), it executes return (count + 1) * 3 (Line 5), which is multiples of three instead of powers of three.

Expected:
Line 5 should be updated to: return 3 ** (count + 1), and the output on Line 9 should be updated to 9.
OR
Line 2 and Line 8 should be updated to MultiplesOfThree

https://docs.python.org/3/library/enum.html#enum.Enum._generate_next_value_

Linked PRs
@Beweeted Beweeted added the docs Documentation in the Doc dir label Dec 11, 2022
@Beweeted Beweeted changed the title Enum Docs do the wrong math for the class name in the _generate_next_value_ example Enum Docs does MultiplesOfThree instead of PowersOfThree Dec 11, 2022
@Beweeted
Copy link
Contributor Author

Or I guess renaming it to ThirdPowers would also work.

@ethanfurman
Copy link
Member

Let's fix the math. @Beweeted would you like to create the PR?

@bedevere-bot bedevere-bot mentioned this issue Dec 11, 2022
Merged
ethanfurman pushed a commit that referenced this issue Dec 11, 2022
@Beweeted
gh-100174: [Enum] Correct PowersOfThree example. (GH-100178)
868bab0 
Changed from multiples of 3 to powers of 3 to match the class name.
@bedevere-bot bedevere-bot mentioned this issue Dec 11, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Dec 11, 2022
@Beweeted @miss-islington
pythongh-100174: [Enum] Correct PowersOfThree example. (pythonGH-100178)
4ce43b5 
Changed from multiples of 3 to powers of 3 to match the class name.
(cherry picked from commit 868bab0)

Co-authored-by: Beweeted <Beweeted@users.noreply.github.com>
miss-islington added a commit that referenced this issue Dec 11, 2022
@miss-islington @Beweeted
gh-100174: [Enum] Correct PowersOfThree example. (GH-100178)
593c5a0 
Changed from multiples of 3 to powers of 3 to match the class name.
(cherry picked from commit 868bab0)

Co-authored-by: Beweeted <Beweeted@users.noreply.github.com>
@ethanfurman
Copy link
Member

Many thanks!

carljm added a commit to carljm/cpython that referenced this issue Dec 14, 2022
@carljm
Merge branch 'main' into typedocs
53d33a1 
* main: (103 commits)
  pythongh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs (python#100249)
  Assorted minor fixes for specialization stats. (pythonGH-100219)
  pythongh-100176: venv: Remove redundant compat code for Python <= 3.2 (python#100177)
  pythonGH-100222: Redefine _Py_CODEUNIT as a union to clarify structure of code unit. (pythonGH-100223)
  pythongh-99955: undef ERROR and SUCCESS before redefining (fixes sanitizer warning) (python#100215)
  pythonGH-100206: use versionadded for the addition of sysconfig.get_default_scheme (python#100207)
  pythongh-81057: Move _Py_RefTotal to the "Ignored Globals" List (pythongh-100203)
  pythongh-81057: Move Signal-Related Globals to _PyRuntimeState (pythongh-100085)
  pythongh-81057: Move faulthandler Globals to _PyRuntimeState (pythongh-100152)
  pythongh-81057: Move tracemalloc Globals to _PyRuntimeState (pythongh-100151)
  pythonGH-100143: Improve collecting pystats for parts of runs (pythonGH-100144)
  pythongh-99955: standardize return values of functions in compiler's code-gen (python#100010)
  pythongh-79218: Define `MS_WIN64` macro for Mingw-w64 64bit on Windows (pythonGH-100137)
  Fix: typo (Indention) (pythonGH-99904)
  pythongh-96715 Remove redundant NULL check in `profile_trampoline` function (python#96716)
  pythongh-100176: remove incorrect version compatibility check from argument clinic (python#100190)
  clarify the 4300-digit limit on int-str conversion (python#100175)
  pythongh-70393: Clarify mention of "middle" scope (python#98839)
  pythongh-99688: Fix outdated tests in test_unary (python#99712)
  pythongh-100174: [Enum] Correct PowersOfThree example. (pythonGH-100178)
  ...
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

No branches or pull requests
2 participants
@ethanfurman @Beweeted