rust-lang / rust-lang/rust-analyzer

LSP: Return appropriate markdown content

Open
#4,326 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lsp S-actionable
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

If HoverClientCapabilities.contentFormat or CompletionClientCapabilities.completionItem.documentationFormat or SignatureHelpClientCapabilities.signatureInformation.documentationFormat are absent then we need to return:

Request Return
Hover MarkedString
Completion string
SignatureHelp string

See: https://microsoft.github.io/language-server-protocol/specifications/specification-3-16/#textDocument_hover

Contributor guide

Open the contributing guide

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 by tracing the LSP handling for hover, completion documentation, and signature-help documentation, then compare the behavior with the linked LSP 3.16 specification. Done means absent format capabilities produce MarkedString for Hover and string for Completion and SignatureHelp.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Bug
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.