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.

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

docs: add a more precise example #121015

Merged
merged 4 commits into from
Nov 1, 2024
Merged

docs: add a more precise example #121015

merged 4 commits into from
Nov 1, 2024

Conversation

Ret2Me
Copy link
Contributor

@Ret2Me Ret2Me commented Jun 26, 2024

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users.
Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.


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

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.
@Ret2Me Ret2Me requested a review from ethanfurman as a code owner June 26, 2024 00:41
Copy link

cpython-cla-bot bot commented Jun 26, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Jun 26, 2024
Copy link
Member

@ethanfurman ethanfurman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the changes are not necessary. I would accept a second example, similar to your proposed example, of ...[('RED', 1), ('GREEN', 2), ....

@bedevere-app
Copy link

bedevere-app bot commented Jul 15, 2024

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Ret2Me
Copy link
Contributor Author

Ret2Me commented Jul 16, 2024

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Jul 16, 2024

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

@willingc
Copy link
Contributor

@ethanfurman I'm triaging open doc PRs. Do you want to review this one again? Thanks!

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ethanfurman for the new review and @Ret2Me for the contribution.

@willingc willingc added the needs backport to 3.12 bug and security fixes label Nov 1, 2024
@willingc willingc added the needs backport to 3.13 bugs and security fixes label Nov 1, 2024
@willingc willingc merged commit ff257c7 into python:main Nov 1, 2024
29 checks passed
@miss-islington-app
Copy link

Thanks @Ret2Me for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 1, 2024
* docs: add a more precise example

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.

* docs: remove whitespace characters

* refactor: change example

---------

(cherry picked from commit ff257c7)

Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]>
Co-authored-by: Ethan Furman <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 1, 2024
* docs: add a more precise example

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.

* docs: remove whitespace characters

* refactor: change example

---------

(cherry picked from commit ff257c7)

Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]>
Co-authored-by: Ethan Furman <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Nov 1, 2024

GH-126306 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 1, 2024
@bedevere-app
Copy link

bedevere-app bot commented Nov 1, 2024

GH-126307 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Nov 1, 2024
@Ret2Me Ret2Me deleted the patch-1 branch November 1, 2024 20:57
willingc pushed a commit that referenced this pull request Nov 1, 2024
)

docs: add a more precise example in enum doc (GH-121015)

* docs: add a more precise example

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.

* docs: remove whitespace characters

* refactor: change example

---------

(cherry picked from commit ff257c7)

Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]>
Co-authored-by: Ethan Furman <[email protected]>
willingc pushed a commit that referenced this pull request Nov 1, 2024
)

docs: add a more precise example in enum doc (GH-121015)

* docs: add a more precise example

Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.

* docs: remove whitespace characters

* refactor: change example

---------

(cherry picked from commit ff257c7)

Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]>
Co-authored-by: Ethan Furman <[email protected]>
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants