From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Fri, 14 Jun 2024 20:26:15 +0000 (+0200)
Subject: docs: refine some comments
X-Git-Tag: v4.0.15~15
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=481f686650060f85e72d1c46d5490dab256aab9c;p=poolifier.git

docs: refine some comments

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

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 51a0dd94..461fe145 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -588,8 +588,8 @@ export abstract class AbstractPool<
   }
 
   /**
-   * The pool readiness boolean status.
-   * @returns The pool readiness status.
+   * Whether the pool is ready or not.
+   * @returns The pool readiness boolean status.
    */
   private get ready (): boolean {
     if (this.empty) {
@@ -607,8 +607,8 @@ export abstract class AbstractPool<
   }
 
   /**
-   * The pool emptiness boolean status.
-   * @returns The pool emptiness status.
+   * Whether the pool is empty or not.
+   * @returns The pool emptiness boolean status.
    */
   protected get empty (): boolean {
     return this.minimumNumberOfWorkers === 0 && this.workerNodes.length === 0
@@ -822,7 +822,7 @@ export abstract class AbstractPool<
 
   /**
    * Whether the pool is full or not.
-   * @returns The pool filling boolean status.
+   * @returns The pool fullness boolean status.
    */
   protected get full (): boolean {
     return (
@@ -833,8 +833,7 @@ export abstract class AbstractPool<
 
   /**
    * Whether the pool is busy or not.
-   *
-   * The pool busyness boolean status.
+   * @returns The pool busyness boolean status.
    */
   protected abstract get busy (): boolean