From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 15 Jul 2023 14:31:37 +0000 (+0200)
Subject: docs: add code comment
X-Git-Tag: v2.6.17~5
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=d4ddb68b76a27c10cd6c1d618767f8a2576ba81b;p=poolifier.git

docs: add code comment

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

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index 01beb340..6bd4fe74 100644
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -123,6 +123,12 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.setTaskStatisticsRequirements(this.opts)
   }
 
+  /**
+   * Whether the worker node is ready or not.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns Whether the worker node is ready or not.
+   */
   protected isWorkerNodeReady (workerNodeKey: number): boolean {
     return this.pool.workerNodes[workerNodeKey].info.ready
   }