add documentation for waitforElementToBeRemoved (#103) #105
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
kentcdodds
reviewed
May 5, 2019
| used in Node-based tests. | ||
|
|
||
| The default `container` is the global `document`. Make sure the elements you | ||
| wait for will be attached to it, or set a different `container`. |
There was a problem hiding this comment.
Would be good to reword this a bit because right now it sounds like it should be a direct child.
| @@ -43,6 +43,21 @@ test('movie title goes away', async () => { | |||
| }) | |||
| ``` | |||
|
|
|||
| The `waitForElementToBeRemoved` [async helper][async-api] function uses a | |||
There was a problem hiding this comment.
Let's move this to be the first example in this section (before the wait example) because it's probably the better option.
* clarify that observed element must be descendent of container * move waitForElementToBeRemoved example above wait example in guide
alexkrolick
reviewed
May 5, 2019
| // logs 'Element no longer in DOM' | ||
| ``` | ||
|
|
||
| The callback must return the pre-existing element or array of elements that are expected to be removed. |
There was a problem hiding this comment.
I think the explanation that the element(s) must be in the DOM when you call the function should be at the top
There was a problem hiding this comment.
No problem, I'll make that change now!
* move that callback must return element above examples * move error handling from first example to second
alexkrolick
approved these changes
May 6, 2019
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.
Addresses #103
This is my first open-source contribution in many years so please let me know if there's anything I can do to improve. Thanks for the opportunity!