From: Jérôme Benoit Date: Mon, 10 Oct 2022 19:28:28 +0000 (+0200) Subject: Uniformize some comments X-Git-Tag: v2.3.1~33 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=23135a899846318ad8c093ee03ae5301782bc011;p=poolifier.git Uniformize some comments Signed-off-by: Jérôme Benoit --- diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 304dfba5..ab6c0940 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -443,10 +443,10 @@ export abstract class AbstractPool< } /** - * Updates tasks run time for the given worker. + * Updates tasks runtime for the given worker. * * @param worker Worker which run the task. - * @param taskRunTime Worker task run time. + * @param taskRunTime Worker task runtime. */ private updateWorkerTasksRunTime ( worker: Worker, diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index f5f1d190..2cf84adb 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -103,10 +103,10 @@ export interface IPoolInternal< getWorkerRunningTasks(worker: Worker): number | undefined /** - * Get worker average tasks run time. + * Get worker average tasks runtime. * * @param worker The worker. - * @returns The average tasks run time on the worker. + * @returns The average tasks runtime on the worker. */ getWorkerAverageTasksRunTime(worker: Worker): number | undefined } diff --git a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts index 19c81f99..e05b6fae 100644 --- a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts @@ -5,7 +5,7 @@ import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy' import type { RequiredStatistics } from './selection-strategies-types' /** - * Virtual task run time. + * Virtual task runtime. */ type TaskRunTime = { weight: number diff --git a/src/utility-types.ts b/src/utility-types.ts index 104725ac..926b3280 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -32,7 +32,7 @@ export interface MessageValue< */ readonly error?: string /** - * Task run time. + * Task runtime. */ readonly taskRunTime?: number /**