🎈 Add Docstrings to Anrede Enum Members#75
Merged
Conversation
hf-kklein
changed the title
hf-krechan
requested changes
Nov 10, 2021
Collaborator
hf-krechan
left a comment
hf-krechan
left a comment
There was a problem hiding this comment.
Nice nice, just two little format change requests =)
|
|
||
| # see https://stackoverflow.com/a/50473952/10009545 | ||
| def __new__(cls, value, doc=None): | ||
| self = str.__new__(cls, value) # calling super().__new__(value) here would fail |
Collaborator
There was a problem hiding this comment.
I tried it with StrEnum but it did not work =(
It seems that it can not find the right ENUM if we use the StrEnum class.
tests/test_enums.py
Outdated
Comment on lines
+49
to
+55
| @staticmethod | ||
| def _get_class_doc(enum_class: TEnum) -> Optional[str]: | ||
| """ | ||
| asserts that enum class is a class and returns the class' docstring | ||
| """ | ||
| assert inspect.isclass(enum_class) | ||
| return inspect.getdoc(enum_class) |
Collaborator
There was a problem hiding this comment.
Could we put this staticmethod at the top of this class?
So you find it before it's first call.
Co-authored-by: Kevin <68426071+hf-krechan@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I'd like to merge this already to see if the docs on https://bo4e-python.readthedocs.io/en/master/api/bo4e.enum.html#module-bo4e.enum.anrede show up after releasing this. It's a "testballon" ;)