From e0b4b319da2671fcbc76be30df31763d6fd2f7e7 Mon Sep 17 00:00:00 2001 From: Marta Bondyra Date: Mon, 9 Nov 2020 14:14:01 +0100 Subject: [PATCH] docs --- .../public/indexpattern_datasource/counter_rate/index.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/counter_rate/index.ts b/x-pack/plugins/lens/public/indexpattern_datasource/counter_rate/index.ts index d514922fde754..7a30446fd551e 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/counter_rate/index.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/counter_rate/index.ts @@ -22,7 +22,6 @@ export type ExpressionFunctionCounterRate = ExpressionFunctionDefinition< Datatable >; -// TODO /** * Calculates the counter rate of a specified column in the data table. * @@ -35,8 +34,10 @@ export type ExpressionFunctionCounterRate = ExpressionFunctionDefinition< * Behavior: * * Will write the counter rate of `inputColumnId` into `outputColumnId` * * If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId` - * * Counter rate always start with an undefined value for the first row of a series, a cell will contain its own value minus the - * value of the previous cell of the same series. + * * Counter rate always start with an undefined value for the first row of a series. + * * If the value of the current cell is not smaller than the previous one, an output cell will contain + * * its own value minus the value of the previous cell of the same series. If the value is smaller, + * * an output cell will contain its own value * * Edge cases: * * Will return the input table if `inputColumnId` does not exist