docs: refine some comments
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 14 Jun 2024 20:26:15 +0000 (22:26 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 14 Jun 2024 20:26:15 +0000 (22:26 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/pools/abstract-pool.ts

index 51a0dd943dfe56d7bb4baefa32fa0b803a217b8b..461fe14560d60b5f617863a6906eb83b2365ac39 100644 (file)
@@ -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