Microsoft/TypeScript

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

Open

#31,885 opened on Jun 13, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
DocsHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

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 https://github.com/jsdoc/jsdoc/issues/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

Contributor guide

Research direction
Edit the wiki page to clarify that @template is a TypeScript specific tag, not standard JSDoc, and update the URL from usejsdoc.org to jsdoc.app.
Tech stack
typescriptjavascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90