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

@sapui5/ts-types-esm - broken links in docs #303

Open
DetachHead opened this issue Nov 24, 2021 · 1 comment
Open

@sapui5/ts-types-esm - broken links in docs #303

DetachHead opened this issue Nov 24, 2021 · 1 comment
Labels
types ES modules types (recommended)

Comments

@DetachHead
Copy link

  /**
   * @deprecated (since 1.85) - use {@link module:sap/base/security/URLListValidator.Entry} instead.
   *
   * Entry object of the URLWhitelist.
   */

webstorm:
image

vscode:
image
clicking it takes you here:
image

@petermuessig petermuessig added the legacy ts-types (with globals) Related to legacy Global types (deprecated) label Nov 28, 2021
@DetachHead DetachHead changed the title @sapui5/ts-types - broken links in docs @sapui5/ts-types-esm - broken links in docs Nov 29, 2021
@petermuessig petermuessig added types ES modules types (recommended) and removed legacy ts-types (with globals) Related to legacy Global types (deprecated) labels Nov 29, 2021
@akudev
Copy link
Contributor

akudev commented Dec 29, 2021

TL;DR: not sure whether module:... JSDoc links are supposed to work at all right now.

microsoft/TypeScript#16498 was about @link with http(s) links, but mentions that symbol links are harder to support due to lacking stuff in the TS compiler APIs.

microsoft/TypeScript#35524 is about the rest and was closed by the "80% solution" in microsoft/TypeScript#41877 which was then reverted and re-tried in microsoft/TypeScript#43312

I frankly don't know whether this PR includes support for module:... links, which were earlier found to only be used in 2% of cases

Also related on VSCode side: microsoft/vscode#99922 was closed, waiting for TS side

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
types ES modules types (recommended)
Projects
None yet
Development

No branches or pull requests

3 participants