RFC: Nonstandard tags that should be processed in "Lax" mode
Open
Nobody has claimed this yet.
request for comments
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
As the strict mode is defined, what things are important to handle in "Lax" mode?
- Unique
@tags - Using
@returninstead of@returns - Using
@typeparaminstead of@param(I haven't seen this but TypeDoc supports it)
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 reviewing how strict and Lax modes are defined, then examine the listed cases: unique @tags, @return versus @returns, and @typeparam versus @param. Done requires an agreed specification for which nonstandard tags Lax mode should process; the payload names no implementation files or tests.
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