Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Adopt @link in vscode.d.ts #120120

Closed
4 of 6 tasks
mjbvz opened this issue Mar 29, 2021 · 1 comment
Closed
4 of 6 tasks

Adopt @link in vscode.d.ts #120120

mjbvz opened this issue Mar 29, 2021 · 1 comment
Assignees
@mjbvz
Labels
debt Code quality issues
Milestone
May 2021

Comments

@mjbvz
Copy link
Collaborator

mjbvz commented Mar 29, 2021 •
edited
Loading

Tracks adopting JSDoc @link tags in vscode.d.ts. Unlike our existing link scheme, these links should work properly in hovers and suggest widgets. However they do require TS 4.3+

  • April: Merge support for @link Support JSDoc @link tags  #119357
  • May: Pick up TS 4.3. Start updating vscode.d.ts to use @link tags.
  • May: Ensure the website's doc generator can parse @link tags.
  • May Release: Users targeting the latest VS Code version get the vscode.d.ts that uses @link. However users targeting older versions of VS Code will get the d.ts that uses our custom link scheme
  • Post May: All new llinks added to vscode.d.ts should use @link
  • Future?: Remove custom link support? This would break #link in old vscode.d.ts versions

We can also try this out in vscode.proposed.d.ts, since we don't have to worry about supporting older versions of that file
@mjbvz mjbvz added this to the May 2021 milestone Mar 29, 2021
@mjbvz mjbvz self-assigned this Mar 29, 2021
@mjbvz mjbvz added the debt Code quality issues label Mar 29, 2021
This was referenced Mar 30, 2021
Closed
Closed
@mjbvz mjbvz mentioned this issue Apr 8, 2021
Closed
mjbvz added a commit that referenced this issue May 3, 2021
@mjbvz
Use @ link in vscode.d.ts
9aac6ab 
For #120120

Converts all links in vscode.d.ts and vscode.proposed.d.ts to use `@link` instead of our custom link scheme. This allows these links to work in IntelliSense popups

I have converted all links over since we want to try to use `@link` everywhere. However a few of them may not work yet due implementation limitations
@mjbvz
Copy link
Collaborator Author

mjbvz commented May 6, 2021

Support for @link should be done now

We'll keep the existing link support around for a little while since most extensions will still be using older versions of vscode.d.ts

@mjbvz mjbvz closed this as completed May 6, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mjbvz mjbvz

Labels
debt Code quality issues
Projects
None yet
Milestone
May 2021
Development

No branches or pull requests
1 participant
@mjbvz