Skip to content

Don't Merge! Added type hints and docstrings (811 lines)#92

Open
rhiza-fr wants to merge 8 commits intoThe-Pocket:mainfrom
rhiza-fr:main
Open

Don't Merge! Added type hints and docstrings (811 lines)#92
rhiza-fr wants to merge 8 commits intoThe-Pocket:mainfrom
rhiza-fr:main

Conversation

@rhiza-fr
Copy link
Copy Markdown

@rhiza-fr rhiza-fr commented Jul 17, 2025

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__.py

This 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_res and exec_res. This may be too brief for some - I see in some examples and doc you used shared_storage, prep_result and exec_result which are more self evident.

Respectfully,

@rhiza-fr
Copy link
Copy Markdown
Author

Responds to issues #61 and #49 .

@zachary62
Copy link
Copy Markdown
Member

Very cool! There was already a merged PR for type hint btw:
#86

@wgong
Copy link
Copy Markdown

wgong commented Jul 17, 2025

Thank you, we should use the codebase with docstring and newlines as the base.
maybe you can add a utility to minify it
And contribute it as the marketing version. Hope the pocketflow owner would consider this compromise.

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.

3 participants