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

How to write Doc String for Enums ? #1725

Open
dschiller opened this issue Oct 29, 2019 · 4 comments
Open

How to write Doc String for Enums ? #1725

dschiller opened this issue Oct 29, 2019 · 4 comments

Comments

@dschiller
Copy link

@dschiller dschiller commented Oct 29, 2019

I want to get the Doc String for every single Enum Item like Timing.Setup.LoginDialog if I hover them ( in this case I want to hover LoginDialog and see 30 Seconds - Maximum Time.. ) in VSCode.

Here the Example Code:

from enum import Enum


class Timing:

    class Setup(Enum):
        Open = 300  # 5 Minutes - Maximum Time the Setup Application needs to open
        LoginDialog = 30  # 30 Seconds - Maximum Time the Fadein of the Login Dialog needs
@karthiknadig karthiknadig self-assigned this Oct 29, 2019
@karthiknadig
Copy link
Member

@karthiknadig karthiknadig commented Oct 30, 2019

@dschiller This looks like a feature request on language server. Moving to the LS repo.

@karthiknadig karthiknadig transferred this issue from microsoft/vscode-python Oct 30, 2019
@jakebailey
Copy link
Member

@jakebailey jakebailey commented Oct 30, 2019

Is there some specification as to how enum member comments are supposed to work? It's possible to show this sort of documentation on enum members, but we'd have to know the "right" way to do it.

@lord-aceldama
Copy link

@lord-aceldama lord-aceldama commented Sep 9, 2020

i, too am hoping for this feature to be implemented. (not useful, just bumping because pep8)

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

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.