Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for extraction of types from docstring #6

Open
ilevkivskyi opened this issue Mar 12, 2017 · 3 comments
Open

Add support for extraction of types from docstring #6

ilevkivskyi opened this issue Mar 12, 2017 · 3 comments

Comments

@ilevkivskyi
Copy link
Owner

We could support at least Google style and Numpydoc

@ilevkivskyi ilevkivskyi changed the title Add support for extraction typers from docstring Add support for extraction types from docstring Oct 28, 2017
@ilevkivskyi ilevkivskyi changed the title Add support for extraction types from docstring Add support for extraction of types from docstring Oct 28, 2017
@jussike
Copy link

jussike commented Nov 13, 2020

any progress about this?

@cclauss
Copy link
Contributor

cclauss commented Jul 18, 2022

@ilevkivskyi
Copy link
Owner Author

@jussike I don't have any immediate plans for this, but open to contributions. (The only requirement, this feature should be behind a flag and type comments should take precedence over docstring types if both are present.)

@cclauss IIUC old Google style is more like

    Args:
        param_name (type): description.
        ...
    Returns:
        type: description.

What you show is what PyCharm uses (also popular style btw)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants