chore(tests): Add documentation to browser test helper functions #7280
Conversation
This file contains 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
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.
The basics
npm run formatandnpm run lintThe details
Resolves
Fixes lack of jsdoc.
Proposed Changes
Change jsdoc rules for browser tests to not require types, because we don't have strong typing here (and do not intend to compile this code before running it).
Add jsdoc for functions in
test_helpers.js.Behavior Before Change
No change in test behaviour.
Reason for Changes
Documentation!
Test Coverage
These are tests.
Documentation
This is documentation!
Additional Information
I think I got the promises right but would appreciate a double-check.