tsdoc-unnecessary-backslash false positive
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Given the following description:
/**
* <ul>
* <li>Lines always end with <code>\n</code> or <code>\0</code>. The former denotes a newline. The latter
* denotes the end of the string.</li>
* </ul>
*/
tsdoc-unnecessary-backslash complains about \n and \0: tsdoc-unnecessary-backslash: A backslash can only be used to escape a punctuation character.
Expected behavior: the documentation should contain the literal string \n and \0.
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 by locating the implementation and tests for the tsdoc-unnecessary-backslash rule, then reproduce the issue with the documentation example in this report. Add a regression case showing that the literal strings \n and \0 are accepted, and run the rule's test suite to confirm the false positive is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100