Clarify nextTick section of getting-started guide #86
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
Following up on vuejs#83, clarify getting started guide to explain that `nextTick` is not necessary when testing DOM updates, but it is still needed for operations that require advancing the event loop.
eddyerburgh
reviewed
Oct 11, 2017
docs/en/guides/getting-started.md
Outdated
| To simplify usage, `vue-test-utils` applies all updates synchronously so you don't need to use `Vue.nextTick` in your tests. | ||
| To simplify usage, `vue-test-utils` applies all updates synchronously so you don't need to use `Vue.nextTick` to test DOM updates in your tests. | ||
|
|
||
| `nextTick` is still necessary when you need to explictly advance the event loop, for operations such as asynchronous callbacks or promise resolution. |
There was a problem hiding this comment.
Can you add it in a note. Like this:
*Note: lorem ipsum ...*
- Putting change in a *Note: * - Changing wording, "to test DOM updates in your tests" felt awkward.
|
Ok, moved it into a note, and fixed what I thought was some awkward wording in my first pass. Let me know if you'd like any more/less explanation, examples, etc. |
eddyerburgh
approved these changes
Oct 11, 2017
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.
Following up on #83, clarify getting started guide to explain that
nextTickis not necessary when testing DOM updates, but it is still needed for operations that require advancing the event loop.