microsoft / microsoft/language-server-protocol

Feature: Ability to get official documentation URL of a symbol e.g. method or function

Open
#1,183 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request new request
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

Consider these use cases:

  1. I see GetFullPathNameW, and the signature helper is not giving me enough info, then I need to go to the Official docs.microsoft.com page to get more info.
  2. I see symbol mysqli_multi_query, then I want to see how it was used, I need to go to https://php.net/mysqli_multi_query
  3. I see a symbol components then I need to go to the page doc.rust-lang.org to see examples and more info about the type it actually returns.

Examples could go on, but the point remains the same. It's not enough to have a signature help alone these days, it would be beneficial if language server had a way to give an Symbol -> External URL action. Naturally for this to work each language server, and used library needs support also.

Thanks for considering.

For instance such an linking field could be in SignatureInformation, e.g.:

export interface SignatureInformation {
        documentationUrl?: string; // <- new optional field here

	label: string;
        documentation?: documentation?: string | MarkupContent;
        parameters?: ParameterInformation[];
        activeParameter?: uinteger;
}

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

The issue points to the TypeScript SignatureInformation interface and proposes an optional documentationUrl field for external symbol documentation. Start by reviewing that interface and related protocol definitions, then determine how a language server should expose URLs across the cited examples. Done means the protocol shape and its intended behavior are clearly decided and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.