RFC: `@see` block tag specifies an item for a "See Also" section
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I use the eslint-plugin-tsdoc for linting, and noticed that the JSDoc @see tag is not supported in the list of TSDoc tags.
We use @see tags extensively in one of our projects, so it would be great to add support for it so the TSDoc ESLint plugin doesn't warn for using that tag.
I'm happy to write a PR. Is all it takes adding this to the list of TSDoc tags?
Contributor guide
No contributing guide indexed for this repository
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
Start with tsdoc/src/details/StandardTags.ts and compare the surrounding standard tag definitions with the linked JSDoc and TSDoc references. Confirm how @see should be represented and check the linting workflow; done means the tag is recognized by TSDoc and no longer triggers the reported ESLint warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100