From 42ba8dc765999a27a355e7d0e07b9bde95437ba3 Mon Sep 17 00:00:00 2001 From: Morgan McCollum Date: Wed, 1 May 2019 15:31:50 -0400 Subject: [PATCH 1/3] update simple sugar to syntactic sugar --- docs/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-22.x/MockFunctionAPI.md | 2 +- website/versioned_docs/version-23.x/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-24.0/MockFunctionAPI.md | 10 +++++----- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/MockFunctionAPI.md b/docs/MockFunctionAPI.md index 199d7a797175..e86345839450 100644 --- a/docs/MockFunctionAPI.md +++ b/docs/MockFunctionAPI.md @@ -196,7 +196,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a simple sugar function for: +Just a syntactic sugar function for: ```js jest.fn(function() { @@ -233,7 +233,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -251,7 +251,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -276,7 +276,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -294,7 +294,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-22.x/MockFunctionAPI.md b/website/versioned_docs/version-22.x/MockFunctionAPI.md index 8ab8ced6dfe5..3fe19b589231 100644 --- a/website/versioned_docs/version-22.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-22.x/MockFunctionAPI.md @@ -164,7 +164,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a simple sugar function for: +Just a syntactic sugar function for: ```js jest.fn(function() { diff --git a/website/versioned_docs/version-23.x/MockFunctionAPI.md b/website/versioned_docs/version-23.x/MockFunctionAPI.md index e675553a6b23..bda1256b3da0 100644 --- a/website/versioned_docs/version-23.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-23.x/MockFunctionAPI.md @@ -191,7 +191,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a simple sugar function for: +Just a syntactic sugar function for: ```js jest.fn(function() { @@ -228,7 +228,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -246,7 +246,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -271,7 +271,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -289,7 +289,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-24.0/MockFunctionAPI.md b/website/versioned_docs/version-24.0/MockFunctionAPI.md index 8fdb075b979b..6a02fc44f3f2 100644 --- a/website/versioned_docs/version-24.0/MockFunctionAPI.md +++ b/website/versioned_docs/version-24.0/MockFunctionAPI.md @@ -197,7 +197,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a simple sugar function for: +Just a syntactic sugar function for: ```js jest.fn(function() { @@ -234,7 +234,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -252,7 +252,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -277,7 +277,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -295,7 +295,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Simple sugar function for: +Syntactic sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); From b32b86dc074f983df48282ce887edacba32fbbce Mon Sep 17 00:00:00 2001 From: Morgan McCollum Date: Thu, 2 May 2019 09:42:58 -0400 Subject: [PATCH 2/3] remove 'just a' before syntactic sugar --- docs/MockFunctionAPI.md | 2 +- website/versioned_docs/version-22.x/MockFunctionAPI.md | 2 +- website/versioned_docs/version-23.x/MockFunctionAPI.md | 2 +- website/versioned_docs/version-24.0/MockFunctionAPI.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/MockFunctionAPI.md b/docs/MockFunctionAPI.md index e86345839450..d8a85a8db967 100644 --- a/docs/MockFunctionAPI.md +++ b/docs/MockFunctionAPI.md @@ -196,7 +196,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a syntactic sugar function for: +Syntactic sugar function for: ```js jest.fn(function() { diff --git a/website/versioned_docs/version-22.x/MockFunctionAPI.md b/website/versioned_docs/version-22.x/MockFunctionAPI.md index 3fe19b589231..75f7dc05bc2b 100644 --- a/website/versioned_docs/version-22.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-22.x/MockFunctionAPI.md @@ -164,7 +164,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a syntactic sugar function for: +Syntactic sugar function for: ```js jest.fn(function() { diff --git a/website/versioned_docs/version-23.x/MockFunctionAPI.md b/website/versioned_docs/version-23.x/MockFunctionAPI.md index bda1256b3da0..db975169828d 100644 --- a/website/versioned_docs/version-23.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-23.x/MockFunctionAPI.md @@ -191,7 +191,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a syntactic sugar function for: +Syntactic sugar function for: ```js jest.fn(function() { diff --git a/website/versioned_docs/version-24.0/MockFunctionAPI.md b/website/versioned_docs/version-24.0/MockFunctionAPI.md index 6a02fc44f3f2..24d61688477f 100644 --- a/website/versioned_docs/version-24.0/MockFunctionAPI.md +++ b/website/versioned_docs/version-24.0/MockFunctionAPI.md @@ -197,7 +197,7 @@ Will result in this error: ### `mockFn.mockReturnThis()` -Just a syntactic sugar function for: +Syntactic sugar function for: ```js jest.fn(function() { From 5f3bb7388302375bea234f78f416de1b3383a72f Mon Sep 17 00:00:00 2001 From: Morgan McCollum Date: Thu, 2 May 2019 09:50:41 -0400 Subject: [PATCH 3/3] add to changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e8ed064057cf..dbf36511e3b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,6 +33,7 @@ - `[@jest/reporters]` Migrate away from `istanbul-api` ([#8294](https://github.com/facebook/jest/pull/8294)) - `[*]` Delete obsolete emails tag from header comment in test files ([#8377](https://github.com/facebook/jest/pull/8377)) - `[expect]` optimize compare nodes ([#8368](https://github.com/facebook/jest/pull/8368)) +- `[docs]` Fix typo in MockFunctionAPI.md ([#8406](https://github.com/facebook/jest/pull/8406)) ### Performance