-
-
Notifications
You must be signed in to change notification settings - Fork 64
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
Make JSDoc comments more useful #708
Comments
This sounds great! This would be a great place to take note of those locations when we spot them. Regarding the documentation of minor variables - I remember doing that a couple of times when I knew less about jsdoc and it seemed appropriate to clarify something. Maybe we can just change those to regular comments if they're still relevant. |
I'd be interested in taking this on, but have some questions (I've never used JSDoc before, but I just read up on some on their documentation and feel ready to give this a try, with a little guidance):
|
That would be awesome! Thanks, @skudbucket! I'll answer what I can, and leave the rest to @ethanbb :
|
Thanks for the help! |
Started working on this in PR #736. People should let me know if there's anything they'd like me to change in the way I'm going about it, otherwise I'm going to just start working my way through and documenting all the components and functions in the same manner as I've done App.js in that PR. Feedback appreciated, especially early on when it's really easy to change course without redoing much work! Thanks! |
…n#708. Maybe fixes both of those. We shall see.
Currently, there are several places in the (now publishable) JSDoc comments where:
Let's clean these up so that the docs make sense!
The text was updated successfully, but these errors were encountered: