RFC: @defaultValue to indicate a default value
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
In API Extractor issue #720 @RueDeRennes asked about supporting @default to indicate a default value.
Some questions:
- Should this be part of core TSDoc?
- Should the tag be
@defaultor@defaultValue? - Should it apply only to properties and fields? What about function parameters?
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 reading the related API Extractor issue #720 and the questions in this RFC about tag naming, scope, and whether the tag belongs in core TSDoc. Done would require a settled decision on those questions and a corresponding TSDoc specification change.
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