tsdoc-malformed-html-name erroneously flagging use of less than symbol
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Something like this fails linting
/**
* Safari < 16.4
*/
tsdoc-malformed-html-name: Invalid HTML element: A space is not allowed here eslint(tsdoc/syntax)
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 eslint-plugin-tsdoc tsdoc/syntax rule and the tsdoc-malformed-html-name diagnostic shown in the issue. Reproduce the Safari < 16.4 example, trace how the less-than symbol is interpreted, and confirm that this valid version text no longer produces the malformed HTML warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100