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

Adds docs about Enum type #11805

Merged
merged 3 commits into from
Feb 22, 2022
Merged

Adds docs about Enum type #11805

merged 3 commits into from
Feb 22, 2022

Conversation

sobolevn
Copy link
Member

For some reason there were no Enum docs at all.
I've placed it in Literal type. Because Enum and Literal types are quite similar.

@sobolevn
Copy link
Member Author

sobolevn commented Dec 20, 2021

@JukkaL can you please enable this feature: https://docs.readthedocs.io/en/stable/pull-requests.html ?

It would be super helpful when reviewing docs changes!

Copy link
Collaborator

@JukkaL JukkaL left a comment

Choose a reason for hiding this comment

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

Thanks! It's a good idea to document enums, since they have quite a lot of specialized support in mypy. There were some minor grammar issues that I didn't comment on -- it seems simpler for me to do a quick editing pass after this has been merged (similar to what I've done with other doc PRs in the past).

There's a merge conflict -- feel free to merge after you've resolved it.

@sobolevn
Copy link
Member Author

Thank you!

@sobolevn sobolevn merged commit bd37ab8 into python:master Feb 22, 2022
sobolevn added a commit that referenced this pull request Feb 22, 2022
After merging #11805 I found out that we are missing several new `Enum` features.

This PR adds them to the docs.

Refs #12026
Refs #12035
@sobolevn sobolevn mentioned this pull request Feb 22, 2022
hauntsaninja pushed a commit that referenced this pull request Feb 23, 2022
After merging #11805 I found out that we are missing several new `Enum` features.

This PR adds them to the docs.

Refs #12026
Refs #12035
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants