From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Tue, 11 Oct 2022 09:16:28 +0000 (+0200)
Subject: Spell fixlets in comment
X-Git-Tag: v2.3.1~27
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=bdede008ae867784cd6dfa7468a930d7c026177b;p=poolifier.git

Spell fixlets in comment

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index ab6c0940..369e5b90 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -305,7 +305,7 @@ export abstract class AbstractPool<
   ): void
 
   /**
-   * Register a listener callback on a given worker.
+   * Registers a listener callback on a given worker.
    *
    * @param worker A worker.
    * @param listener A message listener callback.
diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 6f677da8..e9a093fa 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -46,7 +46,7 @@ export interface PoolOptions<Worker> {
  */
 export interface IPool<Data = unknown, Response = unknown> {
   /**
-   * Perform the task specified in the constructor with the data parameter.
+   * Performs the task specified in the constructor with the data parameter.
    *
    * @param data The input for the specified task. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
@@ -57,7 +57,7 @@ export interface IPool<Data = unknown, Response = unknown> {
    */
   destroy(): Promise<void>
   /**
-   * Set the worker choice strategy in this pool.
+   * Sets the worker choice strategy in this pool.
    *
    * @param workerChoiceStrategy The worker choice strategy.
    */
diff --git a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
index 0d4773ff..25a013ea 100644
--- a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
@@ -55,7 +55,7 @@ export class FairShareWorkerChoiceStrategy<
   }
 
   /**
-   * Compute workers last virtual task timestamp.
+   * Computes workers last virtual task timestamp.
    */
   private updateWorkerLastVirtualTaskTimestamp () {
     for (const worker of this.pool.workers) {
diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 4d302f3d..5b844cc5 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -49,7 +49,7 @@ export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
    */
   requiredStatistics: RequiredStatistics
   /**
-   * Choose a worker in the pool.
+   * Chooses a worker in the pool.
    */
   choose(): Worker
 }
diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts
index 8290f89e..a88a8eed 100644
--- a/src/pools/selection-strategies/worker-choice-strategy-context.ts
+++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts
@@ -39,7 +39,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Get the worker choice strategy instance specific to the pool type.
+   * Gets the worker choice strategy instance specific to the pool type.
    *
    * @param workerChoiceStrategy The worker choice strategy.
    * @returns The worker choice strategy instance for the pool type.
@@ -61,7 +61,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Get the worker choice strategy used in the context.
+   * Gets the worker choice strategy used in the context.
    *
    * @returns The worker choice strategy.
    */
@@ -70,7 +70,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Set the worker choice strategy to use in the context.
+   * Sets the worker choice strategy to use in the context.
    *
    * @param workerChoiceStrategy The worker choice strategy to set.
    */
@@ -83,7 +83,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Choose a worker with the underlying selection strategy.
+   * Chooses a worker with the underlying selection strategy.
    *
    * @returns The chosen one.
    */