[FEATURE] Allow method_descriptors to be serialized as methods #103
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,
I'm trying to add support for python methods created using pyo3. These methods are "built-in" methods, however they can still expose the
__doc__
attribute and a function signature via__text_signature__
.The current implementation detects
method_descriptors
(which is what most native functions end up as), and serializes them as regular methods (since from a caller point of view, they act the same). If the user doesn't provide the__text_signature__
attribute,inspect.signature
will error out, so I made it optional, as I still think it would be useful to have the docstring in the resulting documentation if it exists.Please let me know if this is the right direction for this approach. There are other modifications coming to
mkdocstrings
too, as it currently doesn't populate functions/methods with__text_signature__
or with no signature very well.Thanks,