Skip to content

Commit e21bb35

Browse files
committed
. d minor formatting
1 parent 74a5ee2 commit e21bb35

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,11 @@ echo "hello world!" | python -m approvaltests -t hello
158158

159159
### Selecting a Reporter
160160

161-
All verify functions take an optional `options` parameter that can configure reporters (as well as many other aspects).
161+
All `verify...()` functions take an optional `options` parameter that can configure reporters (as well as many other aspects).
162162

163163
ApprovalTests.Python comes with a few reporters configured, supporting Linux, Mac OSX, and Windows.
164164

165-
In the example shown below, we pass in an options with a reporter we're selecting directly:
165+
In the example shown below, we pass in an `options` with a reporter we're selecting directly:
166166

167167
<!-- snippet: select_reporter_from_class -->
168168
<a id='snippet-select_reporter_from_class'></a>

docs/tutorial/intro-to-reporters.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@
99
* [resources](#resources)<!-- endToc -->
1010

1111
## What is a reporter
12-
When approvaltests fails the mechanism to give you more information about that failing
13-
is via a reporter. Most of the time this means opening a diff tool to show you
12+
13+
When an approval test fails, the mechanism to give you more information about that failing
14+
is via a "reporter". Most of the time this means opening a diff tool to show you
1415
the `.approved.` (expected) vs `.received.` (actual).
1516

1617
The default reporter will search your machine for any installed diff tool.
@@ -21,7 +22,7 @@ See [diff_reporters.csv](../../diff_reporters.csv) for a list of supported diff
2122

2223
## Customizing the reporters.json
2324

24-
You can add a difftool and path to ApprovalTests by editing the [`reporters.json`](../../approvaltests/reporters/reporters.json) file.
25+
You can add a diff tool and path to ApprovalTests by editing the [`reporters.json`](../../approvaltests/reporters/reporters.json) file.
2526

2627
## resources
2728
1. [configuring a reporter](../configuration.md#how-to-configure-a-default-reporter-for-your-system)

0 commit comments

Comments
 (0)