docs: refine worker choice strategies documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 3ae20ea4afe7b9dc2b0b2c8a5386afe43f30874d..e146c7ad128e66a0d6789ddd6e78f7704e88e62a 100644 (file)
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -18,6 +18,7 @@
     "FOSS",
     "Gitter",
     "inheritDoc",
+    "IWWR",
     "jaywcjlove",
     "lcov",
     "libuv",

diff --git a/docs/worker-choice-strategies.md b/docs/worker-choice-strategies.md
index a2b035f7890dadd28183db92b5f17c8546e5af2e..e79bd20c107aacbe70c61764ef7fb891cb21846f 100644 (file)
--- a/docs/worker-choice-strategies.md
+++ b/docs/worker-choice-strategies.md
@@ -20,13 +20,13 @@ By default, the strategy uses the simple moving average task execution time for
 
 ### Weighted round robin
 
-The worker weights are maximum tasks execution time, once the worker has reached its maximum tasks execution time, the next task is assigned to the next worker. The worker default weights are the same for all workers and is computed given the CPU cores speed and theirs numbers.
+The worker weights are maximum tasks execution time, once the worker has reached its maximum tasks execution time, the next task is assigned to the next worker. The default worker weight is the same for each and computed given the CPU cores speed and theirs numbers.
 
 ### Interleaved weighted round robin
 
 The worker weights are maximum tasks execution time. The rounds are the deduplicated worker weights.  
-During a round, if worker weight is inferior to the current round, the next task is assigned to the next worker. Once all workers have been assigned a task, the next round starts.  
-The worker default weights are the same for all workers and is computed given the CPU cores speed and theirs numbers. So the default rounds consists of a unique worker weight.
+During a round, if worker weight is inferior to the current round weight, the next task is assigned to the next worker. Once all workers have been assigned a task, the next round starts.  
+The default worker weights is the same for each and computed given the CPU cores speed and theirs numbers. So the default 'rounds' consists of a unique worker weight.
 
 ## Statistics
 

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 6a6dfe726d6287690eae99934f0dbaa27722360b..5f2edb25b010f9961fcf870c6e661d98abaf0663 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -96,10 +96,10 @@ export interface WorkerChoiceStrategyOptions {
    */
   readonly elu?: MeasurementOptions
   /**
-   * Worker weights to use for weighted round robin worker selection strategy.
-   * Weight is the tasks maximum average or median runtime in milliseconds.
+   * Worker weights to use for weighted round robin worker selection strategies.
+   * A weight is the tasks maximum execution in milliseconds for each worker node.
    *
-   * @defaultValue Computed worker weights automatically given the CPU performance.
+   * @defaultValue Weights computed automatically given the CPU performance.
    */
   readonly weights?: Record<number, number>
 }