@description tag's purpose unclear
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
The @description tag's documentation page properly explains how it can be used. What it doesn't do so well is explaining why/when it should be used, given that - as the page explains - a description can be indicated without using a @description tag.
Please clarify when it is preferable to describe without using @description, using @description, or both.
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
Start with the @description tag documentation page linked in the issue. Review how descriptions are currently explained, then clarify when to use an implicit description, an explicit @description tag, or both. Done means the page clearly explains the preferred use case for each option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100