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

Add documentation related to auto-mocking #8099

Merged
merged 14 commits into from
Mar 18, 2019
+420 −0
Merged

Add documentation related to auto-mocking #8099

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
746ea44
add tests and documentation related to auto mocking
Mar 10, 2019
91b9427
add mock function language and link to the mock function docs
Mar 11, 2019
708cf2c
fix string typo
Mar 11, 2019
1acd876
adjust language for string description
Mar 11, 2019
3ce58b7
line spacing and array property example
Mar 11, 2019
3b92d72
update versioned docs and changelog
Mar 11, 2019
48855e7
fix following typo
Mar 11, 2019
062b28c
update language to consistently use present tense / update versioned …
Mar 12, 2019
1e80856
update function names in test to match example code
Mar 12, 2019
b24fb10
update wording of primitive description
Mar 12, 2019
9df0f20
update wording of primitive description in code comment
Mar 15, 2019
e050750
Merge branch 'master' into auto-mocking-documentation
Mar 17, 2019
df8c6b8
move auto-mocking changelog line under master heading
Mar 17, 2019
b3c807f
move auto-mocking changelog line under master heading
Mar 17, 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
Prev Previous commit
Next Next commit
add mock function language and link to the mock function docs
Mack Solomon committed Mar 11, 2019
commit 91b9427ef6e34ce5a10d8044c00964e114d7b621
2 changes: 1 addition & 1 deletion docs/JestObjectAPI.md
View file
Original file line number Diff line number Diff line change
@@ -123,7 +123,7 @@ This is how `genMockFromModule` will mock the follwing data types:

#### `Function`

A new function will be created. The new function will have no formal parameters and when called will return `undefined`. This functionality also applies to `async functions`.
A new [mock function](https://jestjs.io/docs/en/mock-functions.html) will be created. The new function will have no formal parameters and when called will return `undefined`. This functionality also applies to `async functions`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it harm the meaning to write in present tense and active voice as much as possible? For example:

Create a new mock function which has no formal parameters and returns undefined.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're right about using present tense. I also don't think present tense effects the meaning or makes it unclear. Since the rest of the docs are written in present tense I think I should update this section to match. I'll work on switching everything to present tense.


#### `Class`