Skip to content

Commit 8e924d7

Browse files
fkmyonsi
authored andcommitted
Fix some typos in docs
1 parent 9f5a208 commit 8e924d7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ Consistently(func() bool {
555555
}).Should(BeNumerically("<", 10))
556556
```
557557

558-
note taht `StopTrying(message).Successfully()` is not intended for use with `Eventually`. `Eventually` *always* interprets `StopTrying` as a failure.
558+
Note that `StopTrying(message).Successfully()` is not intended for use with `Eventually`. `Eventually` *always* interprets `StopTrying` as a failure.
559559

560560
You can add additional information to this failure message in a few ways. You can wrap an error via `StopTrying(message).Wrap(wrappedErr)` - now the output will read `<message>: <wrappedErr.Error()>`.
561561

@@ -816,7 +816,7 @@ is just like `BeTrue()` but allows you to pass in a reason. This is a best prac
816816
Ω(ACTUAL).Should(BeFalse())
817817
```
818818

819-
succeeds if `ACTUAL` is `bool` typed and has the value `false`. It is an error for `ACTUAL` to not be a `bool`. You should generaly use `BeFalseBecause` instead to pas in a reason for a more helpful error message.
819+
succeeds if `ACTUAL` is `bool` typed and has the value `false`. It is an error for `ACTUAL` to not be a `bool`. You should generally use `BeFalseBecause` instead to pas in a reason for a more helpful error message.
820820

821821
### BeFalseBecause(reason)
822822

@@ -3203,7 +3203,7 @@ This will now emit a ranking result that will highlight the winning algorithm (i
32033203
- `LowerMaxIsBetter`
32043204
- `HigherMaxIsBetter`
32053205

3206-
We can also inspect the statistics of the two algorithms programatically. `experiment.GetStats` returns a `Stats` object that provides access to the following `Stat`s:
3206+
We can also inspect the statistics of the two algorithms programmatically. `experiment.GetStats` returns a `Stats` object that provides access to the following `Stat`s:
32073207

32083208
- `StatMin` - the data point with the smallest value
32093209
- `StatMax` - the data point with the highest values

0 commit comments

Comments
 (0)