Skip to content

Overloads shouldn't gain @deprecated tags of other overloads in quick info#50904

Merged
sandersn merged 2 commits intomicrosoft:mainfrom
ValerianClerc:main
Oct 11, 2022
Merged

Overloads shouldn't gain @deprecated tags of other overloads in quick info#50904
sandersn merged 2 commits intomicrosoft:mainfrom
ValerianClerc:main

Conversation

@ValerianClerc
Copy link
Copy Markdown
Member

Fixes #49368

This PR updates the hover text for overloaded function signatures: it prevents the @deprecated JSDoc tag from being passed on to other signatures of the same overloaded function (see the linked issue for examples).
This is relevant because it enables the author of the module to deprecate only certain signatures. This behaviour also now aligns the hover text with the existing behaviour of the VS Code "strikethrough" styling.

Please verify that:

  • There is an associated issue in the Backlog milestone (required)
  • Code is up-to-date with the main branch
  • You've successfully run gulp runtests locally
  • [?] There are new or updated unit tests validating the change
    • I've added fourslash tests

Loading
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

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

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Overloads shouldn't gain @deprecated tags of other overloads in quick info

3 participants