microsoft / microsoft/language-server-protocol
ClientDiagnosticsTagOptions seems to be missing in the Markdown specification documents
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13k
- Forks
- 1k
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 10
Description
The interface "DiagnosticClientCapabilities" as defined both in _specifications/lsp/3.17/language/pullDiagnostics.md and _specifications/lsp/3.18/language/pullDiagnostics.md refers to a type named ClientDiagnosticsTagOptions. The latter type, however, is nowhere defined in the Markdown documents!
It can be found, though, in _specifications/lsp/3.18/metaModel/metaModel.json . While I am not sure whether this is intended, I think it would be a good idea to add the definition of ClientDiagnosticsTagOptions to the pullDiagnostics.md document, as well, so that it also appears in the online-documentation at https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the ClientDiagnosticsTagOptions definition in _specifications/lsp/3.18/metaModel/metaModel.json and compare it with the DiagnosticClientCapabilities sections in _specifications/lsp/3.17/language/pullDiagnostics.md and _specifications/lsp/3.18/language/pullDiagnostics.md. Confirm how the Markdown specification documents are produced, then ensure the type definition appears in the relevant pullDiagnostics documentation and online specification output.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100