Browse Source

Docs: Fixed Parameters tables to use defaults col (#23396)

Occurred in a few places for pipeline aggregates.
Randall Britten 8 years ago
parent
commit
c54fa177ef

+ 2 - 2
docs/reference/aggregations/pipeline/avg-bucket-aggregation.asciidoc

@@ -25,8 +25,8 @@ An `avg_bucket` aggregation looks like this in isolation:
 |`buckets_path` |The path to the buckets we wish to find the average for (see <<buckets-path-syntax>> for more
  details) |Required |
  |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` ||
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+ details) |Optional |`skip`
+ |`format` |format to apply to the output value of this aggregation |Optional | `null`
 |===
 
 The following snippet calculates the average of the total monthly `sales`:

+ 3 - 3
docs/reference/aggregations/pipeline/bucket-script-aggregation.asciidoc

@@ -33,9 +33,9 @@ the metrics to use for that variable.
 for more details) |Required |
 |`buckets_path` |A map of script variables and their associated path to the buckets we wish to use for the variable
 (see <<buckets-path-syntax>> for more details) |Required |
- |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` |
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
+ details)|Optional |`skip`
+|`format` |format to apply to the output value of this aggregation |Optional |`null`
 |===
 
 The following snippet calculates the ratio percentage of t-shirt sales compared to total sales each month:

+ 2 - 2
docs/reference/aggregations/pipeline/bucket-selector-aggregation.asciidoc

@@ -38,8 +38,8 @@ the metrics to use for that variable.
 for more details) |Required |
 |`buckets_path` |A map of script variables and their associated path to the buckets we wish to use for the variable
 (see <<buckets-path-syntax>> for more details) |Required |
- |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` |
+|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
+ details)|Optional |`skip`
 |===
 
 The following snippet only retains buckets where the total sales for the month is more than 400:

+ 1 - 1
docs/reference/aggregations/pipeline/cumulative-sum-aggregation.asciidoc

@@ -25,7 +25,7 @@ A `cumulative_sum` aggregation looks like this in isolation:
 |Parameter Name |Description |Required |Default Value
 |`buckets_path` |The path to the buckets we wish to find the cumulative sum for (see <<buckets-path-syntax>> for more
  details) |Required |
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+|`format` |format to apply to the output value of this aggregation |Optional |`null` 
 |===
 
 The following snippet calculates the cumulative sum of the total monthly `sales`:

+ 3 - 3
docs/reference/aggregations/pipeline/derivative-aggregation.asciidoc

@@ -24,8 +24,8 @@ A `derivative` aggregation looks like this in isolation:
 |`buckets_path` |The path to the buckets we wish to find the derivative for (see <<buckets-path-syntax>> for more
  details) |Required |
  |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` |
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+ details)|Optional |`skip` 
+ |`format` |format to apply to the output value of this aggregation |Optional | `null` 
 |===
 
 
@@ -119,7 +119,7 @@ And the following may be the response:
 <1> No derivative for the first bucket since we need at least 2 data points to calculate the derivative
 <2> Derivative value units are implicitly defined by the `sales` aggregation and the parent histogram so in this case the units
 would be $/month assuming the `price` field has units of $.
-<3> The number of documents in the bucket are represented by the `doc_count` f
+<3> The number of documents in the bucket are represented by the `doc_count`
 
 ==== Second Order Derivative
 

+ 3 - 3
docs/reference/aggregations/pipeline/max-bucket-aggregation.asciidoc

@@ -25,9 +25,9 @@ A `max_bucket` aggregation looks like this in isolation:
 |Parameter Name |Description |Required |Default Value
 |`buckets_path` |The path to the buckets we wish to find the maximum for (see <<buckets-path-syntax>> for more
  details) |Required |
- |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` |
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
+ details)|Optional | `skip`
+ |`format` |format to apply to the output value of this aggregation |Optional |`null` 
 |===
 
 The following snippet calculates the maximum of the total monthly `sales`:

+ 2 - 3
docs/reference/aggregations/pipeline/min-bucket-aggregation.asciidoc

@@ -26,11 +26,10 @@ A `max_bucket` aggregation looks like this in isolation:
 |`buckets_path` |The path to the buckets we wish to find the minimum for (see <<buckets-path-syntax>> for more
  details) |Required |
  |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` |
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+ details)|Optional | `skip`
+ |`format` |format to apply to the output value of this aggregation |Optional |`null` 
 |===
 
-
 The following snippet calculates the minimum of the total monthly `sales`:
 
 [source,js]

+ 2 - 2
docs/reference/aggregations/pipeline/sum-bucket-aggregation.asciidoc

@@ -25,8 +25,8 @@ A `sum_bucket` aggregation looks like this in isolation:
 |`buckets_path` |The path to the buckets we wish to find the sum for (see <<buckets-path-syntax>> for more
  details) |Required |
  |`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
- details)|Optional, defaults to `skip` ||
- |`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
+ details)|Optional | `skip`
+ |`format` |format to apply to the output value of this aggregation |Optional |`null` 
 |===
 
 The following snippet calculates the sum of all the total monthly `sales` buckets: