docs: improve code comments
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 23 Sep 2023 10:49:04 +0000 (12:49 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 23 Sep 2023 10:49:04 +0000 (12:49 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/pools/selection-strategies/selection-strategies-types.ts

index b476592ac59e17c3c6c3b64cc4481fcca6bb79cb..90794ea35fe75596f774c924f12cf3982368fbb3 100644 (file)
@@ -188,7 +188,8 @@ export interface IWorkerChoiceStrategy {
   readonly update: (workerNodeKey: number) => boolean
   /**
    * Chooses a worker node in the pool and returns its key.
-   * If the worker node is not eligible, `undefined` is returned.
+   * If no worker nodes are not eligible, `undefined` is returned.
+   * If `undefined` is returned, the caller retry.
    *
    * @returns The worker node key or `undefined`.
    */