Flesh out DOM interaction helper documentation. #287
Merged
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
Turbo87
reviewed
Dec 27, 2017
| @method click | ||
| @param {String|Element} target | ||
| @return {Promise<void>} | ||
| Clicks on the specified selector. |
There was a problem hiding this comment.
"specified target" might be better
| @returns {Event} | ||
|
|
||
| @private | ||
| */ |
There was a problem hiding this comment.
Why did you remove these? They might still be useful for type info
There was a problem hiding this comment.
Hmm, unless we are going to type check ember-test-helpers internally, I don't think this provides any value. This entire file is private and only used to expose the actual public API's which do have valid type information...
There was a problem hiding this comment.
Some IDEs are able to parse these comments and provide hints. Might be useful for future contributors.
There was a problem hiding this comment.
OK, will bring it back for the export (but not the inner / private helper functions)
| @@ -13,16 +13,18 @@ const DEFAULT_MODIFIERS = Object.freeze({ | |||
| }); | |||
|
|
|||
| /** | |||
| Triggers a keyboad event on the specified selector. | |||
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.
No description provided.