Skip to content
This repository was archived by the owner on Apr 14, 2022. It is now read-only.
This repository was archived by the owner on Apr 14, 2022. It is now read-only.

Have hover popups for class instantiation also show constructor docstring #1537

@mawright

Description

@mawright

Environment data

  • VS Code version: 1.25.1
  • Extension version (available under the Extensions sidebar): 2018.6.0
  • OS and version: Ubuntu 16.04
  • Python version (& distribution if applicable, e.g. Anaconda): Anaconda, 3.6.6
  • Type of virtual environment used (N/A | venv | virtualenv | conda | ...): conda
  • Relevant/affected Python packages and their versions: N/A

Actual behavior

Here's some screenshots:

screenshot from 2018-07-13 14-53-55
screenshot from 2018-07-13 14-54-09

Note that in both screenshots, the hover popup only shows the Class docstring.

Note: If there is no class docstring, the hover popup has no docstring info.

Expected (requested?) behavior

Hover popup would include constructor docstring. This is how e.g., IPython behaves.

Python 3.6.6 |Anaconda, Inc.| (default, Jun 28 2018, 17:14:51) 
Type 'copyright', 'credits' or 'license' for more information
IPython 6.4.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import test

In [2]: test.TestClass?
Init signature: test.TestClass(my_param)
Docstring:      Class docstring
Init docstring: Constructor docstring
File:           ~/Code/test/test.py
Type:           type

Steps to reproduce:

N/A

Thanks for the work on the great extension.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions