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

Add consistent & meaningful comments to functions & classes. #8

Open
syntaxseed opened this issue Oct 2, 2019 · 6 comments
Open

Add consistent & meaningful comments to functions & classes. #8

syntaxseed opened this issue Oct 2, 2019 · 6 comments
Labels
easy Should be quite easy to complete hacktoberfest Welcoming contributors for Hacktoberfest!

Comments

@syntaxseed
Copy link
Owner

syntaxseed commented Oct 2, 2019

Much of the original library this was based on had no comments. Need helpful comments for functions, etc.

Use jsdoc style comments.

@syntaxseed syntaxseed added hacktoberfest Welcoming contributors for Hacktoberfest! easy Should be quite easy to complete labels Oct 2, 2019
@zargold
Copy link

zargold commented Oct 2, 2019

I can help with some of this.

@daltlc
Copy link

daltlc commented Oct 2, 2019

I will contribute to this as well.

@Jordan-Rowland
Copy link

I'd be happy to help as well. Since there's 3 of us should we split up some modules so we aren't overlapping on these?

@syntaxseed
Copy link
Owner Author

Thanks guys!

@Jordan-Rowland
Copy link

@daltlc @zargold How would you like to coordinate on this?

@zargold
Copy link

zargold commented Oct 3, 2019

I made a PR so far: if any of you want to continue from there. That's fine or if preferred I can continue to work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Should be quite easy to complete hacktoberfest Welcoming contributors for Hacktoberfest!
Projects
None yet
Development

No branches or pull requests

4 participants