docs: refine code comments

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 56bd0348829590429dc465944fef22b9f28c4b4c..cc9408f2fed30acb97a0dfdca34d0994c245227e 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -191,20 +191,20 @@ export abstract class AbstractPool<
     }
   }
 
     }
   }
 

-  private checkMinimumNumberOfWorkers (numberOfWorkers: number): void {
-    if (numberOfWorkers == null) {
+  private checkMinimumNumberOfWorkers (minimumNumberOfWorkers: number): void {
+    if (minimumNumberOfWorkers == null) {

       throw new Error(
         'Cannot instantiate a pool without specifying the number of workers'
       )
       throw new Error(
         'Cannot instantiate a pool without specifying the number of workers'
       )

-    } else if (!Number.isSafeInteger(numberOfWorkers)) {
+    } else if (!Number.isSafeInteger(minimumNumberOfWorkers)) {

       throw new TypeError(
         'Cannot instantiate a pool with a non safe integer number of workers'
       )
       throw new TypeError(
         'Cannot instantiate a pool with a non safe integer number of workers'
       )

-    } else if (numberOfWorkers < 0) {
+    } else if (minimumNumberOfWorkers < 0) {

       throw new RangeError(
         'Cannot instantiate a pool with a negative number of workers'
       )
       throw new RangeError(
         'Cannot instantiate a pool with a negative number of workers'
       )

-    } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) {
+    } else if (this.type === PoolTypes.fixed && minimumNumberOfWorkers === 0) {

       throw new RangeError('Cannot instantiate a fixed pool with zero worker')
     }
   }
       throw new RangeError('Cannot instantiate a fixed pool with zero worker')
     }
   }

diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts
index 50c3f9c854d4f7224358386fe943074aa8b909f7..1de78aba9f15f1ca2cddb1cdac474c8470e7991f 100644 (file)
--- a/src/pools/selection-strategies/worker-choice-strategy-context.ts
+++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts
@@ -224,6 +224,7 @@ export class WorkerChoiceStrategyContext<
   /**
    * Sets the worker choice strategies in the context options.
    *
   /**
    * Sets the worker choice strategies in the context options.
    *

+   * @param pool - The pool instance.

    * @param opts - The worker choice strategy options.
    */
   public setOptions (
    * @param opts - The worker choice strategy options.
    */
   public setOptions (