Allows Docstring to return a list of DocstringReturns to better work with numpydoc #43
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 for #33
Numpydoc supports multiple return values in the return section. Here's an example:
This PR attempts to add support for multiple return values, since the library only supports a single return value at the moment.
The ideal solution would be updating the existing
Docstring.returns
to returnT.List[DocstringReturns]
instead ofT.Optional[DocstringReturns]
. This is a breaking change, but it's more consistent with how params work. The alternative solution is adding a new property that returnsT.List[DocstringReturns]
, which is what's in this draft PR. I also added a few lines of unit test to showcase the use case. This is only a draft PR. Depending on how the maintainers feel about the backwards compatibility, things may go very differently.