From 677b763ec0a8c592c7395901c8efa1491c138c61 Mon Sep 17 00:00:00 2001 From: Josh Justice Date: Wed, 25 Mar 2020 16:46:22 -0400 Subject: [PATCH] docs: Grammatical Corrections to Async Docs Page (#9679) --- CHANGELOG.md | 1 + docs/TestingAsyncCode.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66b65e836488..3336b6913604 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -49,6 +49,7 @@ ### Chore & Maintenance - `[docs]` Warn about unexpected behavior / bug of node-notifier when using the `notify` options. +- `[docs]` Grammatical corrections to Async docs page. ([#9679](https://github.com/facebook/jest/pull/9679)) - `[jest-resolver]` Use `resolve` package to implement custom module resolution ([#9520](https://github.com/facebook/jest/pull/9520)) - `[jest-runtime]` Move execution of `setupFiles` to `jest-runner` ([#9596](https://github.com/facebook/jest/pull/9596)) - `[@jest/reporters]` Remove unused dependencies and type exports ([#9462](https://github.com/facebook/jest/pull/9462)) diff --git a/docs/TestingAsyncCode.md b/docs/TestingAsyncCode.md index 1b645f6d5963..537bab33551d 100644 --- a/docs/TestingAsyncCode.md +++ b/docs/TestingAsyncCode.md @@ -45,7 +45,7 @@ test('the data is peanut butter', done => { If `done()` is never called, the test will fail (with timeout error), which is what you want to happen. -In case `expect` statement fails it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in `try` block and pass error in `catch` block to `done`. Otherwise, we end up with opaque timeout error and no knowledge of what value was received by `expect(data)`. +If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`. ## Promises @@ -63,7 +63,7 @@ test('the data is peanut butter', () => { Be sure to return the promise - if you omit this `return` statement, your test will complete before the promise returned from `fetchData` resolves and then() has a chance to execute the callback. -If you expect a promise to be rejected use the `.catch` method. Make sure to add `expect.assertions` to verify that a certain number of assertions are called. Otherwise a fulfilled promise would not fail the test. +If you expect a promise to be rejected, use the `.catch` method. Make sure to add `expect.assertions` to verify that a certain number of assertions are called. Otherwise a fulfilled promise would not fail the test. ```js test('the fetch fails with an error', () => { @@ -84,7 +84,7 @@ test('the data is peanut butter', () => { Be sure to return the assertion—if you omit this `return` statement, your test will complete before the promise returned from `fetchData` is resolved and then() has a chance to execute the callback. -If you expect a promise to be rejected use the `.rejects` matcher. It works analogically to the `.resolves` matcher. If the promise is fulfilled, the test will automatically fail. +If you expect a promise to be rejected, use the `.rejects` matcher. It works analogically to the `.resolves` matcher. If the promise is fulfilled, the test will automatically fail. ```js test('the fetch fails with an error', () => {