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.

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

Marking variables private via JSDOC annotations #1

Open
doubleactii opened this issue Jul 29, 2023 · 0 comments
Open

Marking variables private via JSDOC annotations #1

doubleactii opened this issue Jul 29, 2023 · 0 comments
Assignees
Labels
Type: Documentation Improvements or additions to documentation. Type: Maintenance Something that is being worked on to improve the quality of it.

Comments

@doubleactii
Copy link
Member

In the generated docs there are a lot of variables that are marked public when they are in fact private. Mark them private in JSDOC annotation and this should make the docs smaller and easier to read/parse.

This will clear up confusion with maintainers and contributors in the future. This will also clear up confusion with users of the module as they will no longer try to access variables that shouldn't be accessible.

@doubleactii doubleactii added Type: Documentation Improvements or additions to documentation. Type: Maintenance Something that is being worked on to improve the quality of it. labels Jul 29, 2023
@doubleactii doubleactii self-assigned this Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation. Type: Maintenance Something that is being worked on to improve the quality of it.
Projects
None yet
Development

No branches or pull requests

1 participant