-
Notifications
You must be signed in to change notification settings - Fork 155
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
added JsDoc example to fetchValues function #497
Conversation
…isplay functions using JsDoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR @Nkiriobasi! JSDocs and comments aim to add missing context from the implementation. So, a few notes:
- Adding line-by-line comments doesn't add context, as the reader can just read the code with the same level of understanding.
- As stated in the issue, each function should have an
@example
snippet. - A
@param
directive isn't required if an argument is simple enough.
With these specific functions, for example, you probably just want a simple description as the first line, then an @example
snippet. Check this out as a good example.
Also, please be sure deno task ok
passes before committing.
Please let me know if you need anything.
Alright, no problem. I'll refactor. |
Please I'm using one PR with different commit indicating different files. it was not intentional. |
Please run |
Hi @Nkiriobasi, I'll close this PR without merging as I created #533, which superseded this one. I copied some bits from this PR to that one. Please feel free to take a look to get a feel for the style I'm hoping for. Either way, thank you. |
added documentation using JsDoc