docs: enhance pool execute() method documentation
authorJérôme Benoit <jerome.benoit@sap.com>
Sat, 15 Apr 2023 12:33:54 +0000 (14:33 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Sat, 15 Apr 2023 12:33:54 +0000 (14:33 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/pool.ts

index 396c59ad987ea5c9e8294190587917d8036990b5..907bfcb5982f8e1916877e516c3e791eddcc5be0 100644 (file)
@@ -149,9 +149,9 @@ export interface IPool<
    */
   findFreeWorkerNodeKey: () => number
   /**
-   * Executes the function specified in the constructor with the task data parameter.
+   * Executes the function specified in the constructor with the task data input parameter.
    *
-   * @param data - The input for the specified task. This can only be serializable data.
+   * @param data - The task input data for the specified function. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
    */
   execute: (data: Data) => Promise<Response>