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

Improve hover to include title, description and source schema link #480

Closed
ssbarnea opened this issue Jun 3, 2021 · 3 comments · Fixed by #500
Closed

Improve hover to include title, description and source schema link #480

ssbarnea opened this issue Jun 3, 2021 · 3 comments · Fixed by #500
Milestone

Comments

@ssbarnea
Copy link
Member

ssbarnea commented Jun 3, 2021

When hovering over an entry we can now see only the title from the schema and that may prove not enough for some schemas that also have a longer description field too.

Ideally it should look like:

{title}
{description}
Source: <a href='link-to-open-schema'>schema-filename.json</a>

I mention that both title and description may be missing and we should use whatever we find.

One example from XML schemas can be used as a nice implementation example

Screenshot 2021-06-03 at 16 52 20

Also the auto-complete field functionality does not display the field title after the name, something that is highly desired for ansible module arguments. Without this the user would be forced to first auto-complete the entry and make use of hover after in order to understand the purpose of that option.

@evidolob
Copy link
Collaborator

@ssbarnea I create PR for hover.

As for completion, try to press ctrl + space twice you should see documentation popup:

Screenshot 2021-06-30 at 14 34 32

@ssbarnea
Copy link
Member Author

@evidolob Can you please give me some hints on how to test that PR? I always wondered how am I supposed to test yaml-language-server as the deliverable is not an extension, so I need to include it in a local build vscode-yaml but that was not clear to me.

@evidolob
Copy link
Collaborator

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

Successfully merging a pull request may close this issue.

2 participants