✨ Add docstring automation to get help message to typer objects #436
+567
−4
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.
Hi everyone,
Thanks for this awesome library, hope I can help :)
I hope this PR closes #227 and #336
My idea was to let typer get help messages to commands/arguments automatically from the objects docstrings.
I considered 3 docstrings formats: Numpy, Google and reST (Sphinx) (I believe they are the most common, right?).
I heve written some tests, but they can be improved (I felt that were a lot of duplications), and more can be written (units tests and more test cases, like callbacks).