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

Private variables missing in documentation for some classes #8

Open
nottirb opened this issue Dec 2, 2021 · 1 comment
Open

Private variables missing in documentation for some classes #8

nottirb opened this issue Dec 2, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation needed-for-release This is needed for the official contribution release

Comments

@nottirb
Copy link
Owner

nottirb commented Dec 2, 2021

Self explanatory. All properties should be documented, even private class properties, just add the @private tag in the documentation.
@nottirb nottirb added the documentation Improvements or additions to documentation label Dec 2, 2021
@nottirb
Copy link
Owner Author

nottirb commented Dec 2, 2021

This is necessary before we can really start taking contributions, since it'll be hard to understand the code otherwise.

@nottirb nottirb added the needed-for-release This is needed for the official contribution release label Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation needed-for-release This is needed for the official contribution release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nottirb