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.
Closes #203
I decided to go with an approach where the user can specify their own yaml instead of going with a more complex parsing approach.
This has the upsides:
this has the downside:
Implementation notes:
For the future:
Somebody could add functools.wraps to the doc decorators if they would like to use them in conjunction with the docstring
I am not using those decorators so didnt look into that, actually the main point I wanted this feature was to avoid having to use the decorators
Heres a usage example:
https://i.imgur.com/ViynuNY.png
https://i.imgur.com/oORSqRa.png
Feedback welcome, tagging people who could be interested @denisovkv @ruckc @ioggstream