From: Jérôme Benoit Date: Sat, 23 Sep 2023 10:49:04 +0000 (+0200) Subject: docs: improve code comments X-Git-Tag: v2.7.2~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=f6ccb7db9e9a307511bf93f6fd582a39b97e552a;p=poolifier.git docs: improve code comments Signed-off-by: Jérôme Benoit --- 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`. */