@constructor + @class tags both show class members
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 206
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
We use the `@class` tag to give a general description of the class, and `@constructor` to describe its specific arguments - However, the class members are shown for both
https://doclets.io/janmeier/sequelize/janmaster#dl-Sequelize
I think that if `@class` is defined, `@constructor` should not show the members
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 with the linked rendered Sequelize documentation and trace how the @class and @constructor tags are handled. The change is done when defining @class prevents the constructor view from showing the same class members, while preserving the intended descriptions and arguments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100