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聽(48,455 stars)聽(6,726 forks)batch import
DocsHelp Wanted

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

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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with TypeScript wiki's JSDoc support page
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue requests two changes to the TypeScript wiki page 'JSDoc support in JavaScript' (https://github.com/Microsoft/TypeScript/wiki/JSDoc support in JavaScript): (1) Add a note clarifying that @template is a custom TypeScript tag, not a standard JSDoc tag. (2) Update the link from usejsdoc.org to jsdoc.app, as the former no longer redirects. The fix involves editing the wiki page directly; the repository for the wiki is likely a separate git repo (TypeScript.wiki.git) or can be edited via GitHub's wiki interface. The maintainer @sandersn was tagged in the issue. No linked PRs or additional comments indicate ongoing work.
wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference) 路 Microsoft/TypeScript#31885 | Good First Issue