Don't Merge! Added type hints and docstrings (811 lines)#92
Open
rhiza-fr wants to merge 8 commits intoThe-Pocket:mainfrom
Open
Don't Merge! Added type hints and docstrings (811 lines)#92rhiza-fr wants to merge 8 commits intoThe-Pocket:mainfrom
rhiza-fr wants to merge 8 commits intoThe-Pocket:mainfrom
Conversation
Author
This was referenced Jul 17, 2025
Member
|
Very cool! There was already a merged PR for type hint btw: |
|
Thank you, we should use the codebase with docstring and newlines as the base. |
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
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.
Hiya, and thanks for this elegant and powerfull project implemented with extraordinary brevity.
For a friendlier developer experience, this fork adds type hints and docstrings throughout
__init__.pyThis makes autocompletion and inline help available without having to refer to the docs.
Alas, it also forced named parameters to be strictly conformant to the base classes, so this led to many doc and example modifications.... ho hum. Otherwise functionality is unaltered.
I conformed to
__init__.py's naming:shared,prep_resandexec_res. This may be too brief for some - I see in some examples and doc you usedshared_storage,prep_resultandexec_resultwhich are more self evident.Respectfully,