Support tables in TSDoc comments
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
It is frequently useful to break information down into table form. This feature request is not attempting to prescribe a syntax, but using Markdown syntax as an example, it would be VERY nice to be able to write a comment like the following:
/**
* Foo
*
* @remarks
*
* | Foo | Bar | Baz |
* | --- | --- | --- |
* | 1 | 2 | 3 |
*/
export interface Foo { }
And have related tooling (VSCode intellisense, API-Extractor, etc.) correctly recognize the syntax and display the contents as a table.
Note that being able to use other TSDoc tags / syntax within the table is also desired. E.g. being able to leverage {@link } tags within the table.
This could be solved via #12, but that issue has been open for 6 years now, so a smaller / scoped feature request seems appropriate.
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 the table example in this issue and the related proposal in #12, then consider how the syntax would affect VSCode IntelliSense and API Extractor. Done means TSDoc can represent tables, including inline tags such as {@link }, and the named tooling correctly recognizes and displays them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100