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

wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference) #31885

Open
brettz9 opened this issue Jun 13, 2019 · 1 comment
Open
Labels
Docs The issue relates to how you learn TypeScript Help Wanted You can do this PursuitFellowship Help wanted from Pursuit fellowship; others please avoid until Dec 19
Milestone

Comments

@brettz9
Copy link

brettz9 commented Jun 13, 2019

TypeScript Version: N/A

Search Terms: docs, template, wiki

Code

N/A

Expected behavior:

@template is not a recognized tag per https://jsdoc.app/ , even if could be compatible as a custom tag. I think your docs at https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript should make clear that while the other items in the list of jsdoc tags are standard jsdoc, the particular tag @template is an exception and is not standard jsdoc.

Also, the reference to "usejsdoc.org" should be changed to its new site: jsdoc.app. (See jsdoc/jsdoc#1642 on the lack of a working redirect.)

Actual behavior:

  1. https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript seems to imply that @template is a valid, standard jsdoc tag or at least doesn't clarify that it is a custom tag and not one with behaviors compatible with jsdoc.
  2. The docs link to usejsdoc.org

Playground Link:

N/A

Related Issues:

None found.

@sandersn

@sandersn
Copy link
Member

Ah, turns out I misunderstood the claim that jsdoc supports Closure type expression as supporting Closure tags too. @template comes from Closure, although Typescript extends it by allowing constraints.

@sandersn sandersn added Bug A bug in TypeScript Docs The issue relates to how you learn TypeScript Help Wanted You can do this labels Jun 13, 2019
@sandersn sandersn added this to the Backlog milestone Jun 13, 2019
@RyanCavanaugh RyanCavanaugh removed Bug A bug in TypeScript labels Jul 16, 2019
@sandersn sandersn added the PursuitFellowship Help wanted from Pursuit fellowship; others please avoid until Dec 19 label Sep 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs The issue relates to how you learn TypeScript Help Wanted You can do this PursuitFellowship Help wanted from Pursuit fellowship; others please avoid until Dec 19
Projects
None yet
Development

No branches or pull requests

3 participants