Skip to content

Don't return tags when returning quick info for JSDoc nodes #59816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 30, 2025

Conversation

Andarist
Copy link
Contributor

@Andarist Andarist commented Sep 1, 2024

fixes #59402

@typescript-bot typescript-bot added the For Backlog Bug PRs that fix a backlog bug label Sep 1, 2024
//// */
//// function foo(x/*2*/) {}

verify.quickInfoAt("1", "(parameter) x: any", "Does the thing", undefined);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This implements the change described by @mjbvz here. Maybe some JSDoc tags should be returned when requesting quick info for a JSDoc node? I don't know when it would be desirable though. It seems that they always describe an associated node and not itself. The "itself" description gets still returned as part of the documentation string

//// function foo(x/*2*/) {}

verify.quickInfoAt("1", "(parameter) x: any", "Does the thing", undefined);
verify.quickInfoAt("2", "(parameter) x: any", "Does the thing", [{ name: "param", text: "x Does the thing" }]);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that this isn't particularly desirable result either. It still contains duplicate information. I think this should be fixed as part of #57819 though and not here

@github-project-automation github-project-automation bot moved this from Not started to Needs merge in PR Backlog Jun 30, 2025
@jakebailey jakebailey merged commit 58665cf into microsoft:main Jun 30, 2025
32 checks passed
@github-project-automation github-project-automation bot moved this from Needs merge to Done in PR Backlog Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
For Backlog Bug PRs that fix a backlog bug
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Hovering @param comments duplicates the comment in the hover
3 participants