microsoft / microsoft/TypeScript
wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
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:
- https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript seems to imply that
@templateis 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. - The docs link to usejsdoc.org
Playground Link:
N/A
Related Issues:
None found.
@sandersn
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the TypeScript wiki page “JSDoc support in JavaScript” and compare its @template description with the standard tags listed at jsdoc.app. Clarify that @template is not a standard JSDoc tag and replace the outdated usejsdoc.org reference with jsdoc.app; the wiki page should contain both corrections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100