From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 6 May 2023 20:43:46 +0000 (+0200)
Subject: docs: refine code comments
X-Git-Tag: v2.4.12~2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=c7e196baa67e4deb14377afbd9d6d5f655e5c384;p=poolifier.git

docs: refine code comments

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

diff --git a/.vscode/settings.json b/.vscode/settings.json
index e720aad1..010c3dc3 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -9,6 +9,7 @@
     "Benoit",
     "caffeinate",
     "codeql",
+    "commitlint",
     "Dependabot",
     "FOSS",
     "Gitter",
@@ -17,25 +18,30 @@
     "lcov",
     "libuv",
     "loglevel",
-    "MYBENCH",
     "markdownlint",
     "microjob",
     "microtime",
     "mochawesome",
+    "MYBENCH",
     "nocombine",
-    "OPTARG",
     "octocat",
     "opencollective",
+    "OPTARG",
     "Parens",
     "piment",
+    "pioardi",
     "poolifier",
     "poolify",
+    "preinstall",
+    "Quadflieg",
     "serializable",
     "Shinigami",
     "sonarsource",
     "suchmokuo",
     "threadjs",
+    "THREADPOOL",
     "threadwork",
+    "trimmable",
     "tsdoc",
     "typedoc",
     "workerpool"
diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 114ae8c5..b95cf7f3 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -83,7 +83,7 @@ export interface IWorkerChoiceStrategy {
    */
   reset: () => boolean
   /**
-   * Updates worker node strategy internals.
+   * Updates the worker node key strategy internals.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
@@ -95,7 +95,7 @@ export interface IWorkerChoiceStrategy {
    */
   choose: () => number
   /**
-   * Removes a worker node key from strategy internals.
+   * Removes the worker node key from strategy internals.
    *
    * @param workerNodeKey - The worker node key.
    * @returns `true` if the worker node key is removed, `false` otherwise.
diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts
index e5fddc1b..2b3c9fb6 100644
--- a/src/pools/selection-strategies/worker-choice-strategy-context.ts
+++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts
@@ -115,7 +115,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Updates the worker choice strategy internals in the context.
+   * Updates the worker node key in the worker choice strategy internals in the context.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
@@ -141,7 +141,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Removes a worker node key from the worker choice strategy in the context.
+   * Removes the worker node key from the worker choice strategy in the context.
    *
    * @param workerNodeKey - The key of the worker node.
    * @returns `true` if the removal is successful, `false` otherwise.