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

Improve Enum documentation #63

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Improve Enum documentation #63

merged 1 commit into from
Sep 18, 2023

Conversation

dbutenhof
Copy link
Contributor

#57: "The link to the Enums section is broken."

Corrected the link

#58: "Python enum data type needs explicit sub-type."

Streamlined and clarified, I think, but there's no evidence that an explicit sub-type, which essentially would change the default __str__ method, is necessary. I'm assuming that, if this is incorrect, this PR will solicit a relevant response!

resolves #58
resolves #57


By contributing to this repository, I agree to the contribution guidelines.

ARCA-264
ARCA-265

arcalot#57: The link to the Enums section is broken.
arcalot#58: Clarify semantics and use of Enums in Python and Arcaflow.

resolves arcalot#58
resolves arcalot#57
@jaredoconnell
Copy link
Contributor

This is good until/if we get any more examples showing that the explicit string or int enum types are required. And there's a good chance that in those cases, it's a bug, rather than something that needs documentation changes.

@jaredoconnell jaredoconnell merged commit f6c0fb5 into arcalot:main Sep 18, 2023
2 checks passed
@dbutenhof dbutenhof deleted the enum branch September 18, 2023 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python enum data type needs explicit sub-type Enums anchor link is broken
3 participants