Linter: check JSDoc parameter names exist #3279
Merged
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.
Adds a linter rule (using the
eslint-plugin-jsdocplugin foreslint) that checks JSDoc comment parameter names to make sure that the parameters exist.This doesn't enforce that JSDoc comments must exist or that they must be up-to-date.
I have fixed the few instances where we had outdated JSDoc comments and this rule was violated.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Dev only.
How did/will you validate this change?
I ran the linter and it will run as part of CI.
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
N/A.
Merge / deployment checklist