microsoft / microsoft/language-server-protocol

Describe high-level concepts in the specifications page

Open
#881 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification code lens help wanted
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the specifications page and review the Code Lens Request section, where the issue identifies concepts that are used without introduction. Add high-level explanations or links and examples for those concepts; the work is done when a language server implementor can understand the referenced concepts from the page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.