2
0
mirror of https://github.com/hibiken/asynq.git synced 2024-11-13 04:46:39 +08:00

Fix comment typos

This commit is contained in:
Trịnh Đức Bảo Linh 2022-05-17 11:14:15 +07:00 committed by GitHub
parent aefd276146
commit 30d409371b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 18 additions and 18 deletions

View File

@ -201,7 +201,7 @@ const (
// Indicates that the task is processed successfully and retained until the retention TTL expires. // Indicates that the task is processed successfully and retained until the retention TTL expires.
TaskStateCompleted TaskStateCompleted
// Indicates that the task is waiting in a group to be aggreated into one task. // Indicates that the task is waiting in a group to be aggregated into one task.
TaskStateAggregating TaskStateAggregating
) )

View File

@ -28,7 +28,7 @@ func GetRetryCount(ctx context.Context) (n int, ok bool) {
// GetMaxRetry extracts maximum retry from a context, if any. // GetMaxRetry extracts maximum retry from a context, if any.
// //
// Return value n indicates the maximum number of times the assoicated task // Return value n indicates the maximum number of times the associated task
// can be retried if ProcessTask returns a non-nil error. // can be retried if ProcessTask returns a non-nil error.
func GetMaxRetry(ctx context.Context) (n int, ok bool) { func GetMaxRetry(ctx context.Context) (n int, ok bool) {
return asynqcontext.GetMaxRetry(ctx) return asynqcontext.GetMaxRetry(ctx)

View File

@ -59,7 +59,7 @@ func (i *Inspector) Groups(queue string) ([]*GroupInfo, error) {
return res, nil return res, nil
} }
// GroupInfo represents a state of a group at a cerntain time. // GroupInfo represents a state of a group at a certain time.
type GroupInfo struct { type GroupInfo struct {
// Name of the group. // Name of the group.
Group string Group string

View File

@ -607,7 +607,7 @@ func DecodeSchedulerEnqueueEvent(b []byte) (*SchedulerEnqueueEvent, error) {
// Cancelations is a collection that holds cancel functions for all active tasks. // Cancelations is a collection that holds cancel functions for all active tasks.
// //
// Cancelations are safe for concurrent use by multipel goroutines. // Cancelations are safe for concurrent use by multiple goroutines.
type Cancelations struct { type Cancelations struct {
mu sync.Mutex mu sync.Mutex
cancelFuncs map[string]context.CancelFunc cancelFuncs map[string]context.CancelFunc
@ -662,7 +662,7 @@ func NewLease(expirationTime time.Time) *Lease {
} }
} }
// Reset chanegs the lease to expire at the given time. // Reset changes the lease to expire at the given time.
// It returns true if the lease is still valid and reset operation was successful, false if the lease had been expired. // It returns true if the lease is still valid and reset operation was successful, false if the lease had been expired.
func (l *Lease) Reset(expirationTime time.Time) bool { func (l *Lease) Reset(expirationTime time.Time) bool {
if !l.IsValid() { if !l.IsValid() {
@ -700,7 +700,7 @@ func (l *Lease) Deadline() time.Time {
return l.expireAt return l.expireAt
} }
// IsValid returns true if the lease's expieration time is in the future or equals to the current time, // IsValid returns true if the lease's expiration time is in the future or equals to the current time,
// returns false otherwise. // returns false otherwise.
func (l *Lease) IsValid() bool { func (l *Lease) IsValid() bool {
now := l.Clock.Now() now := l.Clock.Now()

View File

@ -65,7 +65,7 @@ func GetRetryCount(ctx context.Context) (n int, ok bool) {
// GetMaxRetry extracts maximum retry from a context, if any. // GetMaxRetry extracts maximum retry from a context, if any.
// //
// Return value n indicates the maximum number of times the assoicated task // Return value n indicates the maximum number of times the associated task
// can be retried if ProcessTask returns a non-nil error. // can be retried if ProcessTask returns a non-nil error.
func GetMaxRetry(ctx context.Context) (n int, ok bool) { func GetMaxRetry(ctx context.Context) (n int, ok bool) {
metadata, ok := ctx.Value(metadataCtxKey).(taskMetadata) metadata, ok := ctx.Value(metadataCtxKey).(taskMetadata)

View File

@ -161,7 +161,7 @@ func CanonicalCode(err error) Code {
} }
/****************************************** /******************************************
Domin Specific Error Types & Values Domain Specific Error Types & Values
*******************************************/ *******************************************/
var ( var (
@ -263,26 +263,26 @@ func IsRedisCommandError(err error) bool {
// New returns an error that formats as the given text. // New returns an error that formats as the given text.
// Each call to New returns a distinct error value even if the text is identical. // Each call to New returns a distinct error value even if the text is identical.
// //
// This function is the errors.New function from the standard libarary (https://golang.org/pkg/errors/#New). // This function is the errors.New function from the standard library (https://golang.org/pkg/errors/#New).
// It is exported from this package for import convinience. // It is exported from this package for import convenience.
func New(text string) error { return errors.New(text) } func New(text string) error { return errors.New(text) }
// Is reports whether any error in err's chain matches target. // Is reports whether any error in err's chain matches target.
// //
// This function is the errors.Is function from the standard libarary (https://golang.org/pkg/errors/#Is). // This function is the errors.Is function from the standard library (https://golang.org/pkg/errors/#Is).
// It is exported from this package for import convinience. // It is exported from this package for import convenience.
func Is(err, target error) bool { return errors.Is(err, target) } func Is(err, target error) bool { return errors.Is(err, target) }
// As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true. // As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.
// Otherwise, it returns false. // Otherwise, it returns false.
// //
// This function is the errors.As function from the standard libarary (https://golang.org/pkg/errors/#As). // This function is the errors.As function from the standard library (https://golang.org/pkg/errors/#As).
// It is exported from this package for import convinience. // It is exported from this package for import convenience.
func As(err error, target interface{}) bool { return errors.As(err, target) } func As(err error, target interface{}) bool { return errors.As(err, target) }
// Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. // Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error.
// Otherwise, Unwrap returns nil. // Otherwise, Unwrap returns nil.
// //
// This function is the errors.Unwrap function from the standard libarary (https://golang.org/pkg/errors/#Unwrap). // This function is the errors.Unwrap function from the standard library (https://golang.org/pkg/errors/#Unwrap).
// It is exported from this package for import convinience. // It is exported from this package for import convenience.
func Unwrap(err error) error { return errors.Unwrap(err) } func Unwrap(err error) error { return errors.Unwrap(err) }

View File

@ -110,7 +110,7 @@ type SchedulerOpts struct {
EnqueueErrorHandler func(task *Task, opts []Option, err error) EnqueueErrorHandler func(task *Task, opts []Option, err error)
} }
// enqueueJob encapsulates the job of enqueing a task and recording the event. // enqueueJob encapsulates the job of enqueuing a task and recording the event.
type enqueueJob struct { type enqueueJob struct {
id uuid.UUID id uuid.UUID
cronspec string cronspec string

View File

@ -242,7 +242,7 @@ func (fn GroupAggregatorFunc) Aggregate(group string, tasks []*Task) *Task {
return fn(group, tasks) return fn(group, tasks)
} }
// An ErrorHandler handles an error occured during task processing. // An ErrorHandler handles an error occurred during task processing.
type ErrorHandler interface { type ErrorHandler interface {
HandleError(ctx context.Context, task *Task, err error) HandleError(ctx context.Context, task *Task, err error)
} }