refactor(docs): optimize comments following Google Go style guide

Simplified documentation comments to be more concise while maintaining clarity.
Changed verbose phrases like "wraps detailed information" to simpler forms like "contains information".
Removed redundant references to "Asynq" in internal documentation where context is clear.
Applied consistent comment style across all exported types and functions.

Author: kaptinlin

client.go

@@ -8,7 +8,7 @@ import (
 	"github.com/hibiken/asynq"
 )
 
-// Client encapsulates an Asynq client instance with custom error handling and job retention settings.
+// Client encapsulates an asynq.Client instance with custom error handling and job retention settings.
 type Client struct {
 	asynqClient  *asynq.Client
 	errorHandler ClientErrorHandler
@@ -88,7 +88,7 @@ func (c *Client) Enqueue(jobType string, payload any, opts ...JobOption) (string
 	return c.EnqueueJob(job)
 }
 
-// EnqueueJob adds a job to the queue based on the provided Job instance.
+// EnqueueJob adds a job to the queue.
 func (c *Client) EnqueueJob(job *Job) (string, error) {
 	task, opts, err := job.ConvertToAsynqTask()
 	if err != nil {
@@ -129,7 +129,7 @@ func (c *Client) handleJobError(err error, job *Job, msg string) {
 	}
 }
 
-// Stop terminates the Asynq client connection, releasing resources.
+// Stop terminates the client connection, releasing resources.
 func (c *Client) Stop() error {
 	return c.asynqClient.Close()
 }

errors.go

@@ -111,7 +111,7 @@ var (
 	ErrQueueNotEmpty = errors.New("queue is not empty")
 )
 
-// ErrSkipRetry indicates a specific Asynq framework condition to skip retries and move the job to the archive.
+// ErrSkipRetry indicates a condition to skip retries and move the job to the archive.
 var ErrSkipRetry = asynq.SkipRetry
 
 // NewSkipRetryError creates and wraps a SkipRetry error with a custom message.

info.go

@@ -6,7 +6,7 @@ import (
 	"github.com/hibiken/asynq"
 )
 
-// WorkerInfo wraps detailed information about an Asynq server, which we treat as a "worker."
+// WorkerInfo contains detailed information about a worker server.
 type WorkerInfo struct {
 	ID             string           `json:"id"`
 	Host           string           `json:"host"`
@@ -19,7 +19,7 @@ type WorkerInfo struct {
 	ActiveJobs     []*ActiveJobInfo `json:"active_jobs"`
 }
 
-// Convert Asynq ServerInfo to WorkerInfo.
+// toWorkerInfo converts asynq.ServerInfo to WorkerInfo.
 func toWorkerInfo(info *asynq.ServerInfo) *WorkerInfo {
 	if info == nil {
 		return nil
@@ -37,7 +37,7 @@ func toWorkerInfo(info *asynq.ServerInfo) *WorkerInfo {
 	}
 }
 
-// ActiveJobInfo wraps detailed information about a job currently being processed by a worker.
+// ActiveJobInfo contains information about a job currently being processed.
 type ActiveJobInfo struct {
 	JobID      string    `json:"job_id"`
 	JobType    string    `json:"job_type"`
@@ -47,7 +47,7 @@ type ActiveJobInfo struct {
 	DeadlineAt time.Time `json:"deadline_at"`
 }
 
-// Convert Asynq WorkerInfo to ActiveJobInfo.
+// toActiveJobInfo converts asynq.WorkerInfo to ActiveJobInfo.
 func toActiveJobInfo(info *asynq.WorkerInfo) *ActiveJobInfo {
 	if info == nil {
 		return nil
@@ -62,7 +62,7 @@ func toActiveJobInfo(info *asynq.WorkerInfo) *ActiveJobInfo {
 	}
 }
 
-// Convert a slice of Asynq WorkerInfo to a slice of ActiveJobInfo.
+// toActiveJobInfoList converts a slice of asynq.WorkerInfo to ActiveJobInfo.
 func toActiveJobInfoList(infos []*asynq.WorkerInfo) []*ActiveJobInfo {
 	activeJobs := make([]*ActiveJobInfo, 0, len(infos))
 	for _, info := range infos {
@@ -71,7 +71,7 @@ func toActiveJobInfoList(infos []*asynq.WorkerInfo) []*ActiveJobInfo {
 	return activeJobs
 }
 
-// QueueInfo includes detailed queue information.
+// QueueInfo contains detailed queue information.
 type QueueInfo struct {
 	Queue       string        `json:"queue"`
 	MemoryUsage int64         `json:"memory_usage"`
@@ -92,7 +92,7 @@ type QueueInfo struct {
 	Timestamp   time.Time     `json:"timestamp"`
 }
 
-// Convert Asynq QueueInfo to QueueInfo.
+// toQueueInfo converts asynq.QueueInfo to QueueInfo.
 func toQueueInfo(info *asynq.QueueInfo) *QueueInfo {
 	if info == nil {
 		return nil
@@ -118,7 +118,7 @@ func toQueueInfo(info *asynq.QueueInfo) *QueueInfo {
 	}
 }
 
-// QueueDailyStats includes detailed daily statistics for a queue.
+// QueueDailyStats contains daily statistics for a queue.
 type QueueDailyStats struct {
 	Queue     string    `json:"queue"`
 	Processed int       `json:"processed"`
@@ -127,7 +127,7 @@ type QueueDailyStats struct {
 	Date      time.Time `json:"date"`
 }
 
-// Convert Asynq QueueDailyStats to our QueueDailyStats structure.
+// toQueueDailyStats converts asynq.DailyStats to QueueDailyStats.
 func toQueueDailyStats(s *asynq.DailyStats) *QueueDailyStats {
 	if s == nil {
 		return nil
@@ -141,7 +141,7 @@ func toQueueDailyStats(s *asynq.DailyStats) *QueueDailyStats {
 	}
 }
 
-// JobInfo includes detailed information for a job, mirroring relevant parts of asynq's TaskInfo and WorkerInfo for active jobs.
+// JobInfo contains detailed information for a job.
 type JobInfo struct {
 	ID            string     `json:"id"`
 	Type          string     `json:"type"`
@@ -164,8 +164,7 @@ type JobInfo struct {
 	Result *string `json:"result,omitempty"`
 }
 
-// toJobInfo converts asynq.TaskInfo and optional asynq.WorkerInfo (for active tasks) to a JobInfo.
-// WorkerInfo is nil for non-active tasks.
+// toJobInfo converts asynq.TaskInfo and optional asynq.WorkerInfo to JobInfo.
 func toJobInfo(ti *asynq.TaskInfo, wi *asynq.WorkerInfo) *JobInfo {
 	if ti == nil {
 		return nil

job.go

@@ -87,7 +87,7 @@ func WithDeadline(deadline *time.Time) JobOption {
 	return func(j *Job) { j.Options.Deadline = deadline }
 }
 
-// ConvertToAsynqTask converts the Job into an Asynq task, ready for enqueueing.
+// ConvertToAsynqTask converts the Job into an asynq.Task, ready for enqueueing.
 func (j *Job) ConvertToAsynqTask() (*asynq.Task, []asynq.Option, error) {
 	if j.Type == "" {
 		return nil, nil, ErrNoJobTypeSpecified
@@ -107,7 +107,7 @@ func (j *Job) ConvertToAsynqTask() (*asynq.Task, []asynq.Option, error) {
 	return asynq.NewTask(j.Type, payloadBytes), opts, nil
 }
 
-// ConvertToAsynqOptions converts the Job's options into Asynq options.
+// ConvertToAsynqOptions converts the Job's options into asynq.Option slice.
 func (j *Job) ConvertToAsynqOptions() []asynq.Option {
 	opts := make([]asynq.Option, 0, 6)
 

scheduler.go

@@ -12,7 +12,7 @@ import (
 // ErrInvalidCronSpec is returned when a cron specification string cannot be parsed.
 var ErrInvalidCronSpec = errors.New("invalid cron spec")
 
-// Scheduler manages job scheduling with Asynq.
+// Scheduler manages periodic job scheduling.
 type Scheduler struct {
 	taskManager    *asynq.PeriodicTaskManager
 	configProvider ConfigProvider

worker.go

@@ -28,7 +28,7 @@ const (
 // DefaultQueues defines default queue names and their priorities.
 var DefaultQueues = map[string]int{DefaultQueue: 1}
 
-// Worker represents a worker that processes tasks using the asynq package.
+// Worker processes tasks from queues.
 type Worker struct {
 	asynqServer  *asynq.Server
 	inspector    *asynq.Inspector
@@ -186,7 +186,7 @@ func (w *Worker) Stop() error {
 	return nil
 }
 
-// setupAsynqServer initializes the Asynq server and inspector based on the provided Redis configuration and worker configuration.
+// setupAsynqServer initializes the asynq server and inspector.
 func (w *Worker) setupAsynqServer(redisConfig *RedisConfig, config *WorkerConfig) {
 	asynqRedisOpt := redisConfig.ToAsynqRedisOpt()
 
@@ -211,7 +211,7 @@ func (w *Worker) setupHandlers(mux *asynq.ServeMux) {
 	}
 }
 
-// makeHandlerFunc creates a task handling function for the Asynq server, applying rate limiting and error handling.
+// makeHandlerFunc creates a task handling function, applying rate limiting and error handling.
 func (w *Worker) makeHandlerFunc(handler *Handler) func(ctx context.Context, task *asynq.Task) error {
 	finalHandler := handler.Process
 	for i := len(w.middlewares) - 1; i >= 0; i-- {
@@ -265,7 +265,7 @@ func (w *Worker) makeHandlerFunc(handler *Handler) func(ctx context.Context, tas
 	}
 }
 
-// retryDelayFunc determines the delay before retrying a task after failure, using custom logic or falling back to Asynq's default.
+// retryDelayFunc determines the delay before retrying a task after failure.
 func (w *Worker) retryDelayFunc(count int, err error, task *asynq.Task) time.Duration {
 	if rateLimitErr, ok := errors.AsType[*ErrRateLimit](err); ok {
 		return rateLimitErr.RetryAfter