Decorator to parse a Sphinx docstring to obtain arg description #109
Conversation
This file contains 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
… and type information
|
Hi Josh, Thank you for the PR! I've finally found some time to take a look at it. Of course I'd ask for unit tests and some refactoring in the new module in order to merge it, but as a demo it looks fantastic. I'd really like to drop the non-KISS P.S.: please merge |
|
Hi, thanks. What refactoring did you have in mind? What do you mean by a non-KISS decorator? |
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.
PR that adds a decorator which parses a function's Sphinx docstring and adds type and description information to the parser.
It hasn't got tests yet but wanted it out there to see if there is an appetite to merge in.