From f6ccb7db9e9a307511bf93f6fd582a39b97e552a Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sat, 23 Sep 2023 12:49:04 +0200 Subject: [PATCH] docs: improve code comments MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- src/pools/selection-strategies/selection-strategies-types.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index b476592a..90794ea3 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -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`. */ -- 2.34.1