Skip to content

Commit 02d58f0

Browse files
committed
Update readme. Close #1
1 parent 337f997 commit 02d58f0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ if (Lottery::odds(1 / 5)->choose()) {
2323
}
2424
```
2525

26-
But you don't care if it fails, as long as it doesn't fail for more than hour. Then you could wrap that code up in Flaky
26+
But you don't care if it fails, as long as it doesn't fail for more than an hour. Then you could wrap that code up in Flaky
2727
protections.
2828

2929
```php
@@ -59,7 +59,7 @@ If you want to throw an exception after a certain period of time, you have sever
5959
- `allowFailuresForDays($days)`
6060
- `allowFailuresFor($seconds = 0, $minutes = 0, $hours = 0, $days = 0)`
6161

62-
If your callback throws an exception, Flaky will check to see if it's still in the grace period. If it is, the exception
62+
If your callback throws an exception, Flaky will check to see if it's still within the grace period. If it is, the exception
6363
will be captured.
6464

6565
If your callback succeeds, the deadline will be reset.
@@ -78,7 +78,7 @@ Flaky::make('my-flaky-code')
7878
})
7979
```
8080

81-
Now your function can fail 10 times in a row without alerting you, but on the 11th failure the exception will be thrown.
81+
Now your function can fail 10 times in a row without alerting you, but on the 11th failure the exception will be thrown. If the callback succeeds, the consecutive failure counter will be reset.
8282

8383
### Total Failures
8484

@@ -116,8 +116,8 @@ Flaky::make('my-flaky-code')
116116

117117
## Reporting instead of throwing
118118

119-
By default, Flaky will actually throw the exception if it occurs outside of the bounds you have define. You can choose
120-
to report that exception instead of throw it, using Laravel's `report` method.
119+
By default, Flaky will actually `throw` the exception if it occurs outside of the bounds you have define. You can choose
120+
to `report` that exception instead of throw it, using Laravel's `report` method.
121121

122122
```php
123123
Flaky::make('my-flaky-code')
@@ -189,7 +189,7 @@ Flaky::make('my-flaky-code')
189189

190190
## Accessing the result
191191

192-
Flaky will return a `Result` class to your for your use.
192+
Flaky will return a `Result` class for your use.
193193

194194
```php
195195
$result = Flaky::make('my-flaky-code')

0 commit comments

Comments
 (0)