From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Thu, 4 Apr 2024 08:41:17 +0000 (+0200)
Subject: docs: refine code comment
X-Git-Tag: v3.1.30~41
X-Git-Url: https://git.piment-noir.org/?p=poolifier.git;a=commitdiff_plain;h=5bec72fd7d60b510224f9dd6bc2c04df4cd23e39

docs: refine code comment

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 5eeb5791..b5e528ec 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -1070,7 +1070,9 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Should return whether the worker is the main worker or not.
+   * Returns whether the worker is the main worker or not.
+   *
+   * @returns `true` if the worker is the main worker, `false` otherwise.
    */
   protected abstract isMain (): boolean