diff pkg/imports/queue.go @ 5601:1222b777f51f

Made golint finally happy.
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Sat, 06 Aug 2022 02:09:57 +0200
parents aaa9e658cabd
children 2dd155cc95ec
line wrap: on
line diff
--- a/pkg/imports/queue.go	Sat Aug 06 00:46:21 2022 +0200
+++ b/pkg/imports/queue.go	Sat Aug 06 02:09:57 2022 +0200
@@ -67,6 +67,7 @@
 		CleanUp() error
 	}
 
+	// FeedbackJob is a job to create feedback.
 	FeedbackJob interface {
 		Job
 		CreateFeedback(int64) Feedback
@@ -98,6 +99,7 @@
 		AutoAccept() bool
 	}
 
+	// JobRemover is a extented JobCreator to remove a job.
 	JobRemover interface {
 		JobCreator
 		RemoveJob() bool
@@ -120,6 +122,7 @@
 )
 
 const (
+	// ReviewJobSuffix is the prefix of review jobs.
 	ReviewJobSuffix  = "#review"
 	reviewJobRetries = 200
 	reviewJobWait    = 10 * time.Minute
@@ -130,6 +133,7 @@
 	minWaitRetry = 5 * time.Second
 )
 
+// ErrRetrying are used to signal a retry.
 var ErrRetrying = errors.New("retrying")
 
 type importQueue struct {
@@ -282,8 +286,8 @@
 
 func (*reviewedJob) CleanUp() error { return nil }
 
-func (r *reviewedJob) CreateFeedback(int64) Feedback {
-	return logFeedback(r.ID)
+func (rj *reviewedJob) CreateFeedback(int64) Feedback {
+	return logFeedback(rj.ID)
 }
 
 func (rj *reviewedJob) Do(
@@ -390,7 +394,6 @@
 	return iqueue.hasImportKindName(kind)
 }
 
-//
 func (q *importQueue) hasImportKindName(kind string) bool {
 	q.creatorsMu.Lock()
 	defer q.creatorsMu.Unlock()
@@ -722,6 +725,7 @@
 	return nil
 }
 
+// DecideImport decides if a given import is accepted or not.
 func DecideImport(
 	ctx context.Context,
 	id int64,
@@ -739,6 +743,8 @@
 	}
 }
 
+// All reports all configured job creators and there kind
+// to the given function.
 func All(fn func(JobKind, JobCreator)) { iqueue.All(fn) }
 
 type logFeedback int64