docs: Add missing and update JSDoc comments (fix #839) #1711
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Not all JSDoc comments are complete. I marked incomplete comments with `@todo` or `FIXME`, so a simple `grep` or `ag` search for either string should make it easy to start filling in missing info bit-by-bit.
I don’t know the architecture of this project, so I did my best to use accurate `{type}` annoations in the JSDoc comments. If I wasn’t able to determine a given field’s type, I usually marked it `{object}`.
|
@hegemonic Step in the right direction? |
|
@hegemonic (ping 😄 ) |
didaquis
approved these changes
Feb 21, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not all JSDoc comments are complete. I marked incomplete comments with
@todoorFIXME, so a simplegreporagsearch for either string should make it easy to start filling in missing info bit-by-bit.I don’t know the architecture of this project, so I did my best to use accurate
{type}annoations in the JSDoc comments. If I wasn’t able to determine a given field’s type, I usually marked it{object}.EDIT: I submitted too fast. :) Edited to put the questionnaire at the top, and my comments after, as indicated by the textarea for the PR.