Skip to content

Commit

Permalink
Fix some typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fkmy authored and onsi committed Nov 5, 2024
1 parent 9f5a208 commit 8e924d7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ Consistently(func() bool {
}).Should(BeNumerically("<", 10))
```

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

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()>`.

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

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.
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.

### BeFalseBecause(reason)

Expand Down Expand Up @@ -3203,7 +3203,7 @@ This will now emit a ranking result that will highlight the winning algorithm (i
- `LowerMaxIsBetter`
- `HigherMaxIsBetter`

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:
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:

- `StatMin` - the data point with the smallest value
- `StatMax` - the data point with the highest values
Expand Down

0 comments on commit 8e924d7

Please sign in to comment.