diff --git a/README.md b/README.md index e1140e9..7c62d29 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Task queues are used as a mechanism to distribute work across multiple machines. ## Quickstart -Make sure you have Go installed ([download](https://golang.org/dl/)). Version `1.13` or higher is required. +Make sure you have Go installed ([download](https://golang.org/dl/)). Version `1.14` or higher is required. Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://blog.golang.org/using-go-modules)) inside the folder. Then install Asynq library with the [`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command: diff --git a/asynq.go b/asynq.go index 3f92c81..54e24cf 100644 --- a/asynq.go +++ b/asynq.go @@ -82,10 +82,10 @@ type TaskInfo struct { // zero if not applicable. NextProcessAt time.Time - // ResulTTL is the retention period after the task is successfully processed. + // ResulTTL is duration of the retention period after the task is successfully processed. ResultTTL time.Duration - // CompletedAt is the time the task is processed successfully. + // CompletedAt is the time when the task is processed successfully. // Zero value (i.e. time.Time{}) indicates no value. CompletedAt time.Time diff --git a/client.go b/client.go index f1e489a..6a4abae 100644 --- a/client.go +++ b/client.go @@ -180,7 +180,7 @@ func (d processInOption) String() string { return fmt.Sprintf("ProcessIn(%v) func (d processInOption) Type() OptionType { return ProcessInOpt } func (d processInOption) Value() interface{} { return time.Duration(d) } -// ResultTTL returns an option to specify the retention period for the task. +// ResultTTL returns an option to specify the duration of retention period for the task. // If this option is provided, the task will be stored as a completed task after successful processing. // A completed task will be deleted after the TTL expires. func ResultTTL(ttl time.Duration) Option {