Skip to content

Move the getDocumentationForSymbol docstring onto the function - #64686

Merged
Jake Bailey (jakebailey) merged 1 commit into
microsoft:mainfrom
patrickkettner:move-documentation-docstring
Oct 8, 2026
Merged

Jake Bailey (jakebailey) merged 1 commit into
microsoft:mainfrom
patrickkettner:move-documentation-docstring

Conversation

@patrickkettner

Copy link
Copy Markdown
Contributor

Fixes #64685

Analysis

The comment describing getDocumentationForSymbol sits above type documentationLocationMapper, so go doc and editor hover present it as that type's documentation and the function has none.

Fix

Moved the comment onto the function. No text changes.

Copilot Checklist

I successfully ran the applicable command at the end of my session, and it completed without error:

  • npx hereby validate
  • npx hereby validate --api (for TypeScript API changes)

I used Claude Code for this change, and I have read and reviewed it.

Copilot AI balanced review requested due to automatic review settings October 8, 2026 02:14
@typescript-automation typescript-automation Bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Oct 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The comment-only change fixes the documentation attachment without changing behavior.

0 open findings

What changed in this PR

Fixes #64685 by attaching the language server’s documentation comment to the function it describes.

Changes:

  • Moves the unchanged comment from documentationLocationMapper to getDocumentationForSymbol.
  • Makes no executable code changes.
File Description
tsc/​internal/​ls/​hover.go Places the docstring directly above its intended function.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

@jakebailey
Jake Bailey (jakebailey) added this pull request to the merge queue Oct 8, 2026
Merged via the queue into microsoft:main with commit fed0bf2 Oct 8, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

getDocumentationForSymbol docstring is attached to documentationLocationMapper

3 participants