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.

Sign up for GitHub

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

Jump to bottom

Use Markdown for signature help descriptions #1212

Open
3 tasks
dbanck opened this issue Mar 15, 2023 · 0 comments
Open
3 tasks

Use Markdown for signature help descriptions #1212

dbanck opened this issue Mar 15, 2023 · 0 comments
Labels
enhancement New feature or request textDocument/signatureHelp

Comments

@dbanck
Copy link
Member

dbanck commented Mar 15, 2023

Background

In #1077 we have introduced support for built-in functions. All function descriptions are available as markdown within terraform-schema. We are currently removing the markdown because our internal LSP protocol uses string instead of MarkupContent for the signature help documentation fields.

UX

Before
CleanShot 2023-03-15 at 15 21 36@2x

After
CleanShot 2023-03-15 at 15 19 12@2x

Proposal

  • Introduce an updated SignatureInformation type with documentation as MarkupContent
  • Introduce an updated ParameterInformation type with documentation as MarkupContent
  • Remove the removal of markdown in ToSignatureHelp

Related LSP methods
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request textDocument/signatureHelp
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dbanck