[standard]refine the comments.

rhosocial · Jun 13, 2024 · 83790e9 · 83790e9
1 parent 254e702
commit 83790e9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/workflow/standard/worker/README.md b/workflow/standard/worker/README.md
@@ -84,7 +84,7 @@ if result.Err != nil {
 Adjust the number of workers in the pool:
 
 ```go
-err := pool.Resize(10)
+err := pool.Resize(5, true) // Resize to 5 workers, stop busy workers
 if err != nil {
     fmt.Println("Resize error:", err)
 }

diff --git a/workflow/standard/worker/pool.go b/workflow/standard/worker/pool.go
@@ -2,6 +2,8 @@
 // Use of this source code is governed by Apache-2.0 license
 // that can be found in the LICENSE file.
 
+// Package worker provides a robust and efficient worker pool implementation.
+// It supports dynamic resizing of the pool, task submission, worker metrics tracking, and graceful shutdown.
 package worker
 
 import (