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

Use inherited docstring from super or abstract base class for implementation methods with no docstring #877

Closed
alexkreidler opened this issue Jan 25, 2021 · 1 comment
Labels
docstrings enhancement New feature or request fixed in next version (main) A fix has been implemented and will appear in an upcoming version

Comments

@alexkreidler
Copy link

Sphinx and other documentation generators output the docstring associated with the super class method if the sub class implementation doesn't have a docstring.

See other discussion in general on StackOverflow and again.

It would be great to have this as a feature, so when hovering or completing a sub class method, the user can see the docstring from the superclass.

Thanks!

@judej judej added the enhancement New feature or request label Jan 25, 2021
@github-actions github-actions bot removed the triage label Jan 25, 2021
@jakebailey jakebailey added the fixed in next version (main) A fix has been implemented and will appear in an upcoming version label Mar 3, 2021
@jakebailey
Copy link
Member

This issue has been fixed in version 2021.3.0, which we've just released. You can find the changelog here: https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md#202130-3-march-2021

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstrings enhancement New feature or request fixed in next version (main) A fix has been implemented and will appear in an upcoming version
Projects
None yet
Development

No branches or pull requests

4 participants