You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What problem do you want to solve?
In #2222 it was mentioned that the codebase doesn't have functions and methods don't have comments for documentation.
I've found the codebase hard to get my head around, especially since functions aren't commented so it's hard to know what they are intended to do, and therefore how to fix them without breaking something.
I've found the same issue when adding my own contributions to the codebase. I believe that the code can benefit from JSdocs style comments to the classes for both contributors and users.
What do you think is the correct solution to this problem?
To add JSdocs style documentation to all (or most) of the functions and methods in the codebase.
Are you willing to submit a pull request to implement this change?
Gladly!
The text was updated successfully, but these errors were encountered:
What version of this package are you using?
1.8.6
What problem do you want to solve?
In #2222 it was mentioned that the codebase doesn't have functions and methods don't have comments for documentation.
I've found the same issue when adding my own contributions to the codebase. I believe that the code can benefit from JSdocs style comments to the classes for both contributors and users.
What do you think is the correct solution to this problem?
To add JSdocs style documentation to all (or most) of the functions and methods in the codebase.
Are you willing to submit a pull request to implement this change?
Gladly!
The text was updated successfully, but these errors were encountered: