microsoft/language-server-protocol

Describe high-level concepts in the specifications page

Open

#881 建立於 2019年12月19日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)HTML (12,810 star) (956 fork)batch import
clarificationcode lenshelp wanted

描述

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.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of LSPDocumentation writing skills
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.