From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Sun, 24 Sep 2023 07:33:09 +0000 (+0200)
Subject: docs: refine wording
X-Git-Tag: v2.7.3~9
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=ce0ab2d71ebd09d5b7139c0539877d146a5f1ebd;p=poolifier.git

docs: refine wording

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

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fe2adbd4..dd22f49e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -46,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `startWorkers` to pool options to whether start the minimum number of workers at pool creation or not.
+- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
 - Add `start()` method to pool API to start the minimum number of workers.
 - Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing on back pressure or not.
 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
diff --git a/docs/api.md b/docs/api.md
index 8e3c7707..4f7c074d 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -122,7 +122,7 @@ An object with these properties:
 
   Default: `{ retries: 6, runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }`
 
-- `startWorkers` (optional) - Start the minimum number of workers at pool creation.  
+- `startWorkers` (optional) - Start the minimum number of workers at pool initialization.  
   Default: `true`
 - `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool.  
   Default: `true`