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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

No documentation for client-side NetworkTables interface #85

Open
cjdenio opened this issue Feb 12, 2020 · 2 comments
Open

No documentation for client-side NetworkTables interface #85

cjdenio opened this issue Feb 12, 2020 · 2 comments

Comments

@cjdenio
Copy link
Contributor

cjdenio commented Feb 12, 2020

First off, there may be documentation that I'm missing. Please disregard this issue if so 馃槃

@ErikBoesen, what are your thoughts on using JSDoc to generate documentation for the client-side NetworkTables interface? There's a wealth of helpful functions in there, but it's hard to find out that they exist. 馃槈
You've already done the hard work of putting JSDoc comment blocks in the code, so it would be pretty easy to do.

Here's a preview of what it might look like:
image

@ErikBoesen
Copy link
Member

First of all, I looked through your work a little bit, and wow. Incredible for your age. Your future is bright, keep it up man. :)

Second of all, sure, if you're willing to take this on I'm fine with it! I'm a little too busy with college classes to handle it (plus I'm not on an FRC team anymore), but you're welcome to contribute. Thanks for taking the time!

@cjdenio
Copy link
Contributor Author

cjdenio commented Feb 12, 2020

Thank you! I wouldn't call myself that incredible, but I appreciate the encouragement! 馃槃

Sorry, I should have clarified. I'm not asking you to write the documentation; I'll gladly do it! I can completely understand that you're busy 馃槈

I threw up a PR, #86 , that fixes some errors with the JSDoc tags.

Thank you for building this amazing software with Electron; it makes it super easy for me to modify the core (and contribute to it) :electron:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants