Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

There should be a better description for constructors #3

Open
schettn opened this issue Jun 2, 2020 · 0 comments
Open

There should be a better description for constructors #3

schettn opened this issue Jun 2, 2020 · 0 comments
Assignees
@Aichnerc @kleberbaum @schettn @pinterid
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@schettn
Copy link
Member

schettn commented Jun 2, 2020

Is your feature request related to a problem? Please describe.
I'm always frustrated when I initialise a new instance of a class without knowing what this constructor does.

Describe the solution you'd like
We should have a meeting about it and define a new TONIC rule for this issue.

Additional context
Ref: https://jsdoc.app/tags-inline-link.html
@schettn schettn added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jun 2, 2020
@schettn schettn mentioned this issue Jun 2, 2020
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Aichnerc Aichnerc

@kleberbaum kleberbaum

@schettn schettn

@pinterid pinterid

Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Aichnerc @kleberbaum @schettn @pinterid