Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simple sugar text correction in Mock Function docs #8406

Merged
merged 3 commits into from
May 2, 2019
+17 −16
Merged

Simple sugar text correction in Mock Function docs #8406

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42ba8dc
update simple sugar to syntactic sugar
morganmccol May 1, 2019
b32b86d
remove 'just a' before syntactic sugar
morganmccol May 2, 2019
5f3bb73
add to changelog
morganmccol May 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -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

10 changes: 5 additions & 5 deletions docs/MockFunctionAPI.md
View file
Original file line number Diff line number Diff line change
@@ -196,7 +196,7 @@ Will result in this error:

### `mockFn.mockReturnThis()`

Just a simple sugar function for:
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));
2 changes: 1 addition & 1 deletion website/versioned_docs/version-22.x/MockFunctionAPI.md
View file
Original file line number Diff line number Diff line change
@@ -164,7 +164,7 @@ Will result in this error:

### `mockFn.mockReturnThis()`

Just a simple sugar function for:
Syntactic sugar function for:

```js
jest.fn(function() {
10 changes: 5 additions & 5 deletions website/versioned_docs/version-23.x/MockFunctionAPI.md
View file
Original file line number Diff line number Diff line change
@@ -191,7 +191,7 @@ Will result in this error:

### `mockFn.mockReturnThis()`

Just a simple sugar function for:
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));
10 changes: 5 additions & 5 deletions website/versioned_docs/version-24.0/MockFunctionAPI.md
View file
Original file line number Diff line number Diff line change
@@ -197,7 +197,7 @@ Will result in this error:

### `mockFn.mockReturnThis()`

Just a simple sugar function for:
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));