Skip to content

Commit 437d063

Browse files
committed
Fixed some mistypess in cron README.
1 parent d8035a8 commit 437d063

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

pkg/modules/cron/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Cron
22

3-
Cron is the module which implements a cron specific parser and notifications about scheduler events.
3+
Cron is the module that implements a cron specific parser and notifications about scheduler events.
44

55
## Usage
66

7-
Usage of cron module is described by the [example](/examples/cron/).
7+
The example [describes usage of cron module](/examples/cron/).
88

9-
To import module in your code write following line:
9+
To import module in your code, write the following line:
1010

1111
```go
1212
import "github.com/dipdup-net/indexer-sdk/pkg/modules/cron"
@@ -33,7 +33,9 @@ if err := cronModule.Close(); err != nil {
3333

3434
## Config
3535

36-
Default yaml config of cron module contains only one field `jobs`. It's a map of job names to cron pattern. Job names is used like subscription id in inner-message communication.
36+
Default yaml config of cron module contains only one field `jobs`.
37+
It's a map of job names to a cron pattern.
38+
Job names are used like subscription id in inner-message communication.
3739

3840
```yaml
3941
cron:
@@ -46,7 +48,9 @@ cron:
4648
4749
## Output
4850
49-
Module sends to its outputs empty struct which notifies all connected modules about scheduled event. Each job of cron module has own output with names pointed in configuration file. So if your module should execute some work on `every_second` scheduled events from example you should connect it:
51+
Module sends to its outputs empty struct which notifies all connected modules about scheduled event.
52+
Each job of cron module has its own output with names pointed in the configuration file.
53+
So if your module should execute some work on `every_second` scheduled events from example you should connect it:
5054

5155
```go
5256
// with helper function
@@ -62,7 +66,7 @@ if err := cronModule.AttachTo("every_second", customModule.everySecond); err !=
6266
}
6367
```
6468

65-
Example of handling message from cron's outputs:
69+
Example of a handling message from cron's outputs:
6670

6771
```go
6872
for {

0 commit comments

Comments
 (0)