From 554083128b8fa22dce295cd4d5a9c79e81e7b120 Mon Sep 17 00:00:00 2001
From: Alexander Baryshnikov <dev@baryshnikov.net>
Date: Mon, 21 Sep 2020 23:09:05 +0800
Subject: [PATCH] docs: add some comments

---
 worker/doc.go    | 4 ++++
 worker/worker.go | 4 ++++
 2 files changed, 8 insertions(+)
 create mode 100644 worker/doc.go

diff --git a/worker/doc.go b/worker/doc.go
new file mode 100644
index 0000000..790bdb9
--- /dev/null
+++ b/worker/doc.go
@@ -0,0 +1,4 @@
+// Processing unit
+//
+// Worker manages requests, queuing and re-queuing.
+package worker
diff --git a/worker/worker.go b/worker/worker.go
index 73fa1df..7e90eef 100644
--- a/worker/worker.go
+++ b/worker/worker.go
@@ -122,12 +122,15 @@ func (mgr *Worker) init() error {
 	})
 }
 
+// Cleanup internal resource.
 func (mgr *Worker) Close() {
 	if fn := mgr.cleanup; fn != nil {
 		fn()
 	}
 }
 
+// Enqueue request to storage, save meta-info to meta storage and push id into processing queue. Generated ID
+// always unique and returns only in case of successful enqueue.
 func (mgr *Worker) Enqueue(req *http.Request) (string, error) {
 	id, err := mgr.saveRequest(req)
 	if err != nil {
@@ -138,6 +141,7 @@ func (mgr *Worker) Enqueue(req *http.Request) (string, error) {
 	return id, err
 }
 
+// Complete request manually.
 func (mgr *Worker) Complete(requestID string) error {
 	err := mgr.meta.Complete(requestID)
 	if err != nil {