docs: refine code documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/src/utils.ts b/src/utils.ts
index a6f5fbcc5b729b98f5dec1da1de8178eff830d40..87c4888db0770d15bc624371eccb716809938934 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -32,7 +32,10 @@ export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsR
   }
 
 /**
- * Safe helper to get the host OS optimized maximum pool size.
+ * Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
+ * Always returns a value greater than zero.
+ *
+ * @returns The host OS optimized maximum pool size.
  */
 export const availableParallelism = (): number => {
   let availableParallelism = 1

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 25be4820a0e8c59faa8917e0a809633c0d97de83..2a027269f990375f2a1556372a463e5b9f726655 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -202,7 +202,7 @@ export abstract class AbstractWorker<
    * Handles an error and convert it to a string so it can be sent back to the main worker.
    *
    * @param e - The error raised by the worker.
-   * @returns Message of the error.
+   * @returns The error message.
    */
   protected handleError (e: Error | string): string {
     return e as string