chore: update js-doc throughout the app, batch 1 #5309
Merged
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
Signed-off-by: Erik Kieckhafer <[email protected]>
Signed-off-by: Erik Kieckhafer <[email protected]>
Signed-off-by: Erik Kieckhafer <[email protected]>
Signed-off-by: Erik Kieckhafer <[email protected]>
Signed-off-by: Erik Kieckhafer <[email protected]>
von-steinkirch
approved these changes
Jul 15, 2019
Contributor
von-steinkirch
left a comment
There was a problem hiding this comment.
Erik, I run your branch and the warnings are down to 417! Almost half, very cool.
| * @summary Gets the primary shop | ||
| * @param {Object} parentObject - unused | ||
| * @param {Object} args - unused | ||
| * @param {Object} _ - unused |
Contributor
There was a problem hiding this comment.
Hi, curious what's the meaning of this change (and what does having "_" mean).
Member
Author
There was a problem hiding this comment.
@bt3gl we have all our queries / mutations set up to accept these three params: parentResult, inputArgs, and context. In a lot of cases, we don't need to pass in parentResult or any args, so we use _ and __ as placeholders for these fields.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves parts of #5269 & #5267
Impact: major
Type: docs|chore
Issue
We are missing entire
jsdocblocks in some instances, and param / return / description lines ofjsdocin other instances, along with otherjsdocerrors, all throughout Reaction. This is the biggest contributor to oureslintwarnings.Solution
Add / fix
jsdocwhere necessary.Since there are so many of these warnings, I'm going to split it up into multiple PR's to keep the file count low for easier viewing / less conflicts with open branches.
Breaking changes
None
Testing
More detail for what each of these sections should include are available in our Contributing Docs