ENH: use __text_signature__ if pydoc.doc does not reveal a signature. #73
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.
This allows to support the
__text_signature__
property on Python 3.4+ to document C functions.I had a problem since I started my project: I could either support IPython autocompletion for parameters or use numpydoc and have the signature.
Say, I have a C Function with a docstring:
IPython isn't able to parse a Signature because
inspect.Signature
just doesn't know what to do with it. numpydoc and sphinx however document it correctly.If I change it to
IPython and
inspect.Signature
do work. But they seem to remove it from the docstring. Therefore numpydoc (probably even sphinx itself) can't document the signature frompydoc.getdoc
.Accessing the
__text_signature__
solves this problem! I locally get correctly rendered signatures AND IPythons autocompletion. No idea if it breaks something else, at least my project now renders correctly.