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

Provide API for allowing a SignatureInformation's documentation to be in Markdown #13

Open
rcjsuen opened this issue Feb 28, 2018 · 1 comment
Open

Provide API for allowing a SignatureInformation's documentation to be in Markdown #13

rcjsuen opened this issue Feb 28, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@rcjsuen
Copy link
Owner

rcjsuen commented Feb 28, 2018

We should inspect the client's capabilities.textDocument.signatureHelp.signatureInformation.documentationFormat property to determine what kind of markup the client supports. If it supports Markdown then we should use Markdown in the documentation field of SignatureInformations.
@rcjsuen rcjsuen added the enhancement New feature or request label Feb 28, 2018
@rcjsuen
Copy link
Owner Author

rcjsuen commented Mar 1, 2018

Opened rcjsuen/dockerfile-language-server#208 for the issue described by the original comment.

What we need to do in the language service is to introduce an API or flag of some sort so allow clients to toggle whether they want a signature's documentation returned in Markdown in plain text.

@rcjsuen rcjsuen changed the title Use Markdown for SignatureInformation's documentation if the client supports it Provide API for allowing a SignatureInformation's documentation to be in Markdown Mar 1, 2018
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rcjsuen