search

syntaxseed / terminalfaker

Terminal Faker - A client-side Linux-like cli terminal simulation written in Javascript. Originally forked from AVGP/terminal.js.
MIT License
51 stars 20 forks source link

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

Open syntaxseed opened 5 years ago

syntaxseed commented 5 years ago

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

Use jsdoc style comments.

zargold commented 5 years ago

I can help with some of this.

daltlc commented 5 years ago

I will contribute to this as well.

Jordan-Rowland commented 5 years ago

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 commented 5 years ago

Thanks guys!

Jordan-Rowland commented 5 years ago

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

zargold commented 5 years ago

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.