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

Formatting Parameter Hints #64695

Closed
jfinity opened this issue Dec 9, 2018 · 3 comments
Closed

Formatting Parameter Hints #64695

jfinity opened this issue Dec 9, 2018 · 3 comments
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) editor-parameter-hints Function, method and class parameter hint widget feature-request Request for new features or functionality under-discussion Issue is under discussion for relevance, priority, approach

Comments

@jfinity
Copy link

jfinity commented Dec 9, 2018

If my environment has formatting available for the language that I'm working in, it would be awesome if parameter hints (or really any other "generated" syntactic content for tooltips/popovers) was formatted for better readability -- probably according to whatever drives the formatOnSave feature. This would make it easier to parse/use unfamiliar APIs, especially when they have a lot of options. It could even be opt-in via a toggle in user settings (like formatOnSave is).

@jrieken jrieken added feature-request Request for new features or functionality under-discussion Issue is under discussion for relevance, priority, approach editor-parameter-hints Function, method and class parameter hint widget labels Dec 10, 2018
@maciejmatczak
Copy link

For such python example with docstrings (!):

def function1(arg1: int, arg2: str) -> str:
    """Very important function

    Args:
        arg1: description1
        arg2: description2

    Returns:
        Some string
    """
    pass

I am getting really nice hinting when I am typing the name of the function:
s1
...but the first moment I type "(", it switches into SignatureHelp (command: "Trigger Parameter Hints"), which is not formatted:
s2

TBH, I am not sure what triggers first view, but as both of those shares the same information value, I do prefer the one formatted.

@jrieken jrieken assigned octref and unassigned jrieken Oct 8, 2019
@jrieken
Copy link
Member

jrieken commented Oct 8, 2019

/duplicate #55044

@vscodebot vscodebot bot added the *duplicate Issue identified as a duplicate of another issue(s) label Oct 8, 2019
@vscodebot
Copy link

vscodebot bot commented Oct 8, 2019

Thanks for creating this issue! We figured it's covering the same as another one we already have. Thus, we closed this one as a duplicate. You can search for existing issues here. See also our issue reporting guidelines.

Happy Coding!

@vscodebot vscodebot bot closed this as completed Oct 8, 2019
@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) editor-parameter-hints Function, method and class parameter hint widget feature-request Request for new features or functionality under-discussion Issue is under discussion for relevance, priority, approach
Projects
None yet
Development

No branches or pull requests

4 participants