search

rcjsuen / dockerfile-language-service

Dockerfile language service for providing an API to create feature-rich Dockerfile editors in JavaScript.
MIT License
16 stars 2 forks source link

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

Open rcjsuen opened 6 years ago

rcjsuen commented 6 years ago

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 commented 6 years ago

Opened rcjsuen/dockerfile-language-server-nodejs#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.