From 34a184c7aa5b2a8532ff264cb68e4cd37acf0356 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 29 Aug 2019 09:23:29 -0600 Subject: [PATCH 1/2] various flux function fixes --- .../flux/functions/built-in/misc/intervals.md | 1 + .../transformations/aggregates/histogramquantile.md | 2 +- .../built-in/transformations/aggregates/increase.md | 13 +++++++------ .../built-in/transformations/aggregates/quantile.md | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/content/v2.0/reference/flux/functions/built-in/misc/intervals.md b/content/v2.0/reference/flux/functions/built-in/misc/intervals.md index d36acade3..9d585b9c0 100644 --- a/content/v2.0/reference/flux/functions/built-in/misc/intervals.md +++ b/content/v2.0/reference/flux/functions/built-in/misc/intervals.md @@ -8,6 +8,7 @@ menu: name: intervals parent: built-in-misc weight: 401 +draft: true --- The `intervals()` function generates a set of time intervals over a range of time. diff --git a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/histogramquantile.md b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/histogramquantile.md index 7b135a9d8..84edae201 100644 --- a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/histogramquantile.md +++ b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/histogramquantile.md @@ -75,7 +75,7 @@ _**Data type:** String_ The assumed minimum value of the dataset. When the quantile falls below the lowest upper bound, interpolation is performed between `minValue` and the lowest upper bound. When `minValue` is equal to negative infinity, the lowest upper bound is used. -Defaults to `0`. +Defaults to `0.0`. _**Data type:** Float_ diff --git a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md index b948fb865..b7fabe52c 100644 --- a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md +++ b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md @@ -10,7 +10,8 @@ menu: weight: 501 --- -The `increase()` function calculates the total non-negative difference between values in a table. +The `increase()` function calculates the total non-negative difference between +subsequent values in a table. A main use case is tracking changes in counter values which may wrap over time when they hit a threshold or are reset. In the case of a wrap/reset, we can assume that the absolute delta between two @@ -20,16 +21,16 @@ _**Function type:** Aggregate_ _**Output data type:** Float_ ```js -increase(column: "_values") +increase(columns: ["_value"]) ``` ## Parameters -### column -The column for which the increase is calculated. -Defaults to `"_value"`. +### columns +The columns for which the increase is calculated. +Defaults to `["_value"]`. -_**Data type:** Strings_ +_**Data type:** Array of strings_ ## Examples ```js diff --git a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/quantile.md b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/quantile.md index c9c41436e..a322e83c7 100644 --- a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/quantile.md +++ b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/quantile.md @@ -66,7 +66,7 @@ A selector method that returns the data point for which at least `q` points are ### compression Indicates how many centroids to use when compressing the dataset. A larger number produces a more accurate result at the cost of increased memory requirements. -Defaults to 1000. +Defaults to `1000.0`. _**Data type:** Float_ From e5ed4171afe37238763f40a43e8f6330660153cf Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 29 Aug 2019 09:25:55 -0600 Subject: [PATCH 2/2] minor update to increase function doc --- .../functions/built-in/transformations/aggregates/increase.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md index b7fabe52c..1865d9a6e 100644 --- a/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md +++ b/content/v2.0/reference/flux/functions/built-in/transformations/aggregates/increase.md @@ -11,7 +11,7 @@ weight: 501 --- The `increase()` function calculates the total non-negative difference between -subsequent values in a table. +subsequent values. A main use case is tracking changes in counter values which may wrap over time when they hit a threshold or are reset. In the case of a wrap/reset, we can assume that the absolute delta between two @@ -27,7 +27,7 @@ increase(columns: ["_value"]) ## Parameters ### columns -The columns for which the increase is calculated. +The columns to use in the operation. Defaults to `["_value"]`. _**Data type:** Array of strings_