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.

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

API doc generator mishandles linking for QuickPick<T> and friends #7001

Open
gjsjohnmurray opened this issue Feb 1, 2024 · 1 comment
Open
Assignees
Labels
doc-bug out of date, inaccurate, confusing content
Milestone

Comments

@gjsjohnmurray
Copy link
Contributor

  1. Go to https://code.visualstudio.com/api/references/vscode-api
  2. Search in the page for the text createQuickPick to find the doc for this function of the vscode.window object.
  3. Observe that the return type QuickPick<T> is marked up as two hyperlinks:

image

  1. Click on the first, which seeks a non-existent in-page anchor QuickPick so nothing happens.
  2. Similarly the second one seeks anchor T that doesn't exist.

I guess this is a result of the API generator not treating FooBar<T> as a special case that should be wrapped in a single link to #FooBar&lt;T&gt; instead of creating the two links that are appropriate for non-T cases such as the return type of provideRenameEdits, which is ProviderResult<WorkspaceEdit>.

Fixing this would significantly improve API navigation for extension developers.

@ntrogh ntrogh added the doc-bug out of date, inaccurate, confusing content label Feb 1, 2024
@ntrogh
Copy link
Contributor

ntrogh commented Feb 2, 2024

Thanks for pointing this out @gjsjohnmurray. I'll take it up with the team.

@ntrogh ntrogh assigned ntrogh and rzhao271 and unassigned ntrogh Feb 6, 2024
@rzhao271 rzhao271 added this to the Backlog milestone Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-bug out of date, inaccurate, confusing content
Projects
None yet
Development

No branches or pull requests

3 participants