[FEATURE] Add documentation lint
Open
Nobody has claimed this yet.
Priority: Low
Status: Accepted
Time: ~6 hours
Type: Enhancement
- Dominant language
- TypeScript
- Stars
- 4.1k
- Forks
- 415
- PR merge metrics
- No merged PRs in 30d
Description
If documentation is invalid, Compodoc shows warning log.
export default class Foo {
/**
* @param {number} x
*/
method(p){}
}
Contributor guide
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
The issue does not name any files, tests, or entry points. Start by reproducing the warning with the TypeScript example and clarify which invalid documentation cases the lint should detect and what the resulting warning should contain; done means the intended invalid documentation is consistently reported.
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
- Needs clarification
- Newbie friendliness
- 25/100