Skip to content

Commit 1c5d830

Browse files
morganmccolSimenB
authored andcommitted
Simple sugar text correction in Mock Function docs (#8406)
1 parent 4941d12 commit 1c5d830

File tree

5 files changed

+17
-16
lines changed

5 files changed

+17
-16
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- `[@jest/reporters]` Migrate away from `istanbul-api` ([#8294](https://github.com/facebook/jest/pull/8294))
3535
- `[*]` Delete obsolete emails tag from header comment in test files ([#8377](https://github.com/facebook/jest/pull/8377))
3636
- `[expect]` optimize compare nodes ([#8368](https://github.com/facebook/jest/pull/8368))
37+
- `[docs]` Fix typo in MockFunctionAPI.md ([#8406](https://github.com/facebook/jest/pull/8406))
3738

3839
### Performance
3940

docs/MockFunctionAPI.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Will result in this error:
196196

197197
### `mockFn.mockReturnThis()`
198198

199-
Just a simple sugar function for:
199+
Syntactic sugar function for:
200200

201201
```js
202202
jest.fn(function() {
@@ -233,7 +233,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn());
233233

234234
### `mockFn.mockResolvedValue(value)`
235235

236-
Simple sugar function for:
236+
Syntactic sugar function for:
237237

238238
```js
239239
jest.fn().mockImplementation(() => Promise.resolve(value));
@@ -251,7 +251,7 @@ test('async test', async () => {
251251

252252
### `mockFn.mockResolvedValueOnce(value)`
253253

254-
Simple sugar function for:
254+
Syntactic sugar function for:
255255

256256
```js
257257
jest.fn().mockImplementationOnce(() => Promise.resolve(value));
@@ -276,7 +276,7 @@ test('async test', async () => {
276276

277277
### `mockFn.mockRejectedValue(value)`
278278

279-
Simple sugar function for:
279+
Syntactic sugar function for:
280280

281281
```js
282282
jest.fn().mockImplementation(() => Promise.reject(value));
@@ -294,7 +294,7 @@ test('async test', async () => {
294294

295295
### `mockFn.mockRejectedValueOnce(value)`
296296

297-
Simple sugar function for:
297+
Syntactic sugar function for:
298298

299299
```js
300300
jest.fn().mockImplementationOnce(() => Promise.reject(value));

website/versioned_docs/version-22.x/MockFunctionAPI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Will result in this error:
164164

165165
### `mockFn.mockReturnThis()`
166166

167-
Just a simple sugar function for:
167+
Syntactic sugar function for:
168168

169169
```js
170170
jest.fn(function() {

website/versioned_docs/version-23.x/MockFunctionAPI.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Will result in this error:
191191

192192
### `mockFn.mockReturnThis()`
193193

194-
Just a simple sugar function for:
194+
Syntactic sugar function for:
195195

196196
```js
197197
jest.fn(function() {
@@ -228,7 +228,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn());
228228

229229
### `mockFn.mockResolvedValue(value)`
230230

231-
Simple sugar function for:
231+
Syntactic sugar function for:
232232

233233
```js
234234
jest.fn().mockImplementation(() => Promise.resolve(value));
@@ -246,7 +246,7 @@ test('async test', async () => {
246246

247247
### `mockFn.mockResolvedValueOnce(value)`
248248

249-
Simple sugar function for:
249+
Syntactic sugar function for:
250250

251251
```js
252252
jest.fn().mockImplementationOnce(() => Promise.resolve(value));
@@ -271,7 +271,7 @@ test('async test', async () => {
271271

272272
### `mockFn.mockRejectedValue(value)`
273273

274-
Simple sugar function for:
274+
Syntactic sugar function for:
275275

276276
```js
277277
jest.fn().mockImplementation(() => Promise.reject(value));
@@ -289,7 +289,7 @@ test('async test', async () => {
289289

290290
### `mockFn.mockRejectedValueOnce(value)`
291291

292-
Simple sugar function for:
292+
Syntactic sugar function for:
293293

294294
```js
295295
jest.fn().mockImplementationOnce(() => Promise.reject(value));

website/versioned_docs/version-24.0/MockFunctionAPI.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Will result in this error:
197197

198198
### `mockFn.mockReturnThis()`
199199

200-
Just a simple sugar function for:
200+
Syntactic sugar function for:
201201

202202
```js
203203
jest.fn(function() {
@@ -234,7 +234,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn());
234234

235235
### `mockFn.mockResolvedValue(value)`
236236

237-
Simple sugar function for:
237+
Syntactic sugar function for:
238238

239239
```js
240240
jest.fn().mockImplementation(() => Promise.resolve(value));
@@ -252,7 +252,7 @@ test('async test', async () => {
252252

253253
### `mockFn.mockResolvedValueOnce(value)`
254254

255-
Simple sugar function for:
255+
Syntactic sugar function for:
256256

257257
```js
258258
jest.fn().mockImplementationOnce(() => Promise.resolve(value));
@@ -277,7 +277,7 @@ test('async test', async () => {
277277

278278
### `mockFn.mockRejectedValue(value)`
279279

280-
Simple sugar function for:
280+
Syntactic sugar function for:
281281

282282
```js
283283
jest.fn().mockImplementation(() => Promise.reject(value));
@@ -295,7 +295,7 @@ test('async test', async () => {
295295

296296
### `mockFn.mockRejectedValueOnce(value)`
297297

298-
Simple sugar function for:
298+
Syntactic sugar function for:
299299

300300
```js
301301
jest.fn().mockImplementationOnce(() => Promise.reject(value));

0 commit comments

Comments
 (0)