RFC: Escaping doc comments inside doc comments
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
It's useful to users to include code examples in documentation comments. Sometimes you need to illustrate what the output of different code examples are, so you put it in a comment below, and if it's multiple lines, you use a block comment. The problem is that TSDoc doesn't correctly parse this:
/**
* ```
* getAverage()
* /* 'some output' */
* ```
*/
function getAverage(x, y) {
return (x + y) / 2.0;
}
I think it should handle block comments when they're inside a code block in the documentation comment.
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
Reproduce the TypeScript example from the issue with the repository's TSDoc parser; no implementation file or test is named, so first locate the parser entry point and related code-block tests. Done means a block comment inside a fenced code example remains part of that example without terminating or corrupting the surrounding documentation comment.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100