microsoft/language-server-protocol

Describe high-level concepts in the specifications page

Open

#881 aberto em 19 de dez. de 2019

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12.810 stars) (956 forks)batch import
clarificationcode lenshelp wanted

Description

The specification page mentions some concepts without introducing the concepts themselves.

For example, in the Code Lens Request section:

The code lens request is sent from the client to the server to compute code lenses for a given text document.

As a language server implementor I'm not necessarily familiar with these concepts, so a high-level explanation (or a link to a place where these concepts are described) and an example would help.

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic understanding of LSPDocumentation writing skills
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
Review the specification document to identify sections where concepts are introduced without explanation. For each such concept, draft a brief high level explanation and include an example. Consider linking to external resources for further reading. Ensure the additions follow the existing documentation style.