RFE - extract docstring for params from function docstring #739
Comments
|
What are you talking about? |
|
Sorry, let me be more specific: My suggestion is why not determine the documentation of the corresponding parameter from the docstring of the function. For instance the docstring for function_with_types_in_docstring can be extracted and is returned by jedi. However, there's a problem in supporting various docstring formats.
|
|
You are right. This would be a good idea. Parsing it is probably not that hard, since such logic already exists. ( |
|
I agree, maintaining backwards compatibility is necessary as this is widely used. How about we add this feature as an optional one, via an optional parameter to call_Getsignatures. I am more than happy to submit a pull request if you think this is the right approach. |
|
@DonJayamanne Sorry for not answering back then. Are you still interested in doing such a pull request? I unfortunately don't really like working with docstrings and so I'm probably not going to do it :). |
|
Closing for now. Happy to reopen if someone feels like they want to work on this :). |
Oops, sorry for not replying. Somehow missed the original message. |
Currently when getting the parameter information, the docstring is empty.
Could we not extract (via some string parsing) extract this from the docstring and return this information along with the param info.
The text was updated successfully, but these errors were encountered: