Should the stdlib provide an API to examine function/class field descriptions in docstrings?

[PIG208 (Zixuan Li)]

I see how you are approaching this without hitting the “yet-another-standard” problem, by having the consumer specify the docstr parser. But I think it is the core issue here.

@ajoino

this proposal is useless if we don’t wish to put this feature in the stdlib

I think this has been brought up in the previous thread, as in:

@pf_moore

Putting this feature in the stdlib should only be done if there is already consensus. It doesn’t bring consensus, it acknowledges it.

so we really want it to be useful enough for it to be added to the stdlib.

@ajoino

inspect.register_docstr_parser(NumpyDocstrParser()), and now inspect.getfielddoc and inspect.validatefielddoc will work with all objects using numpy-style docstrings.

Where should the implementation of NumpyDocstrParser be hosted? I feel that this set of APIs is useful only internally to linters/parsers written in or partially in Python, but it is missing the point of PEP 727 which is to have a standardized format for parameter docstrings.