tsdoc-param-tag-missing-hyphen asks for hyphen but tests for hyphen-minus
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Example (line 10: hyphen-minus, line 11: hyphen):
/**
* Locale representing language and region.
*
* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale
* @see https://github.com/microsoft/TypeScript/issues/37326
*/
export class Locale {
/**
*
* @param _language - the language of the `Locale`
* @param _region – the region of the `Locale` or `null`
*/
constructor(private _language: string, private _region: string | null) {}
[…]
> eslint . --ext .ts
/[…]/src/locale.ts
11:6 warning tsdoc-param-tag-missing-hyphen: The @param block should be followed by a parameter name and then a hyphen tsdoc/syntax
✖ 1 problem (0 errors, 1 warning)
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 warning with the example in src/locale.ts by running eslint . --ext .ts. Compare the @param lines containing a hyphen-minus and a hyphen, then inspect the tsdoc-param-tag-missing-hyphen rule and its tests. Done means the rule consistently handles the characters described by its diagnostic without introducing a warning for the intended form.
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
- Clearly specified
- Newbie friendliness
- 35/100