Microsoft/TypeScript

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

Open

#31,885 opened on 2019年6月13日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
DocsHelp Wanted

説明

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

コントリビューターガイド

技術スタック
typescriptjavascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
familiarity with TypeScript wiki's JSDoc support page
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
95
調査方針
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.