fixed formatting of data types throughout flux function docs

pull/516/head
Scott Anderson 2019-10-14 10:43:37 -06:00
parent af24739894
commit 0b2ee3fab6
13 changed files with 38 additions and 34 deletions

View File

@ -37,7 +37,7 @@ It then multiplies the result by 100 and returns a value between -100 and +100.
### n ### n
The period or number of points to use in the calculation. The period or number of points to use in the calculation.
_**Data type: Integer**_ _**Data type:** Integer_
### columns ### columns
The columns to operate on. The columns to operate on.

View File

@ -27,7 +27,7 @@ count(column: "_value")
The column on which to operate. The column on which to operate.
Defaults to `"_value"`. Defaults to `"_value"`.
_**Data type: String**_ _**Data type:** String_
## Examples ## Examples
```js ```js

View File

@ -72,36 +72,36 @@ to include "fitted" data points in results when [`withFit`](#withfit) is set to
### n ### n
The number of values to predict. The number of values to predict.
_**Data type: Integer**_ _**Data type:** Integer_
### seasonality ### seasonality
The number of points in a season. The number of points in a season.
Defaults to `0`. Defaults to `0`.
_**Data type: Integer**_ _**Data type:** Integer_
### interval ### interval
The interval between two data points. The interval between two data points.
_**Data type: Duration**_ _**Data type:** Duration_
### withFit ### withFit
Return [fitted data](#fitted-model) in results. Return [fitted data](#fitted-model) in results.
Defaults to `false`. Defaults to `false`.
_**Data type: Boolean**_ _**Data type:** Boolean_
### timeColumn ### timeColumn
The time column to use. The time column to use.
Defaults to `"_time"`. Defaults to `"_time"`.
_**Data type: String**_ _**Data type:** String_
### column ### column
The column to operate on. The column to operate on.
Defaults to `"_value"`. Defaults to `"_value"`.
_**Data type: String**_ _**Data type:** String_
## Examples ## Examples

View File

@ -35,13 +35,13 @@ for market noise or volatility.
### n ### n
The period or number of points to use in the calculation. The period or number of points to use in the calculation.
_**Data type: Integer**_ _**Data type:** Integer_
### column ### column
The column to operate on. The column to operate on.
Defaults to `"_value"`. Defaults to `"_value"`.
_**Data type: String**_ _**Data type:** String_
## Examples ## Examples
```js ```js

View File

@ -34,7 +34,7 @@ Higher values represent a more efficient or trending market.
### n ### n
The period or number of points to use in the calculation. The period or number of points to use in the calculation.
_**Data type: Integer**_ _**Data type:** Integer_
## Examples ## Examples
```js ```js

View File

@ -39,11 +39,13 @@ experimental.addDuration(
### d ### d
The duration to add. The duration to add.
_**Data type: Duration**_ _**Data type:** Duration_
### to ### to
The time to add the [duration](#d) to. The time to add the [duration](#d) to.
_**Data type:** Time_
## Examples ## Examples
### Add six hours to a timestamp ### Add six hours to a timestamp

View File

@ -41,19 +41,19 @@ _For more information, see the following:_
- [Google Cloud IAM How-to guides](https://cloud.google.com/iam/docs/how-to) - [Google Cloud IAM How-to guides](https://cloud.google.com/iam/docs/how-to)
- [Setting Up Authentication for Server to Server Production Applications on Google Cloud](https://cloud.google.com/docs/authentication/production) - [Setting Up Authentication for Server to Server Production Applications on Google Cloud](https://cloud.google.com/docs/authentication/production)
_**Data type: String**_ _**Data type:** String_
### project ### project
The project ID of the Cloud Bigtable project to retrieve data from. The project ID of the Cloud Bigtable project to retrieve data from.
_**Data type: String**_ _**Data type:** String_
### instance ### instance
The instance ID of the Cloud Bigtable instance to retrieve data from. The instance ID of the Cloud Bigtable instance to retrieve data from.
_**Data type: String**_ _**Data type:** String_
### table ### table
The name of the Cloud Bigtable table to retrieve data from. The name of the Cloud Bigtable table to retrieve data from.
_**Data type: String**_ _**Data type:** String_

View File

@ -42,12 +42,12 @@ mqtt.to(
### broker ### broker
The MQTT broker connection string. The MQTT broker connection string.
_**Data type: String**_ _**Data type:** String_
### topic ### topic
The MQTT topic to send data to. The MQTT topic to send data to.
_**Data type: String**_ _**Data type:** String_
### message ### message
The message or payload to send to the MQTT broker. The message or payload to send to the MQTT broker.
@ -58,50 +58,50 @@ If there are multiple output tables, it sends each table as a separate MQTT mess
When you specify a message, the function sends the message string only (no output table). When you specify a message, the function sends the message string only (no output table).
{{% /note %}} {{% /note %}}
_**Data type: String**_ _**Data type:** String_
### qos ### qos
The [MQTT Quality of Service (QoS)](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901103) level. The [MQTT Quality of Service (QoS)](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901103) level.
Values range from `[0-2]`. Values range from `[0-2]`.
Default is `0`. Default is `0`.
_**Data type: Integer**_ _**Data type:** Integer_
### clientid ### clientid
The MQTT client ID. The MQTT client ID.
_**Data type: String**_ _**Data type:** String_
### username ### username
The username to send to the MQTT broker. The username to send to the MQTT broker.
Username is only required if the broker requires authentication. Username is only required if the broker requires authentication.
If you provide a username, you must provide a [password](#password). If you provide a username, you must provide a [password](#password).
_**Data type: String**_ _**Data type:** String_
### password ### password
The password to send to the MQTT broker. The password to send to the MQTT broker.
Password is only required if the broker requires authentication. Password is only required if the broker requires authentication.
If you provide a password, you must provide a [username](#username). If you provide a password, you must provide a [username](#username).
_**Data type: String**_ _**Data type:** String_
### name ### name
_(Optional)_ The name for the MQTT message. _(Optional)_ The name for the MQTT message.
_**Data type: String**_ _**Data type:** String_
### timeout ### timeout
The MQTT connection timeout. The MQTT connection timeout.
Default is `1s`. Default is `1s`.
_**Data type: Duration**_ _**Data type:** Duration_
### timeColumn ### timeColumn
The column to use as time values in the output line protocol. The column to use as time values in the output line protocol.
Default is `"_time"`. Default is `"_time"`.
_**Data type: String**_ _**Data type:** String_
### tagColumns ### tagColumns
The columns to use as tag sets in the output line protocol. The columns to use as tag sets in the output line protocol.

View File

@ -33,7 +33,7 @@ experimental.objectKeys(
### o ### o
The object to return keys from. The object to return keys from.
_**Data type: Object**_ _**Data type:** Object_
## Examples ## Examples

View File

@ -36,7 +36,7 @@ prometheus.scrape(
### url ### url
The URL to scrape Prometheus-formatted metrics from. The URL to scrape Prometheus-formatted metrics from.
_**Data type: String**_ _**Data type:** String_
## Examples ## Examples

View File

@ -40,7 +40,7 @@ An object that defines the columns and values to set.
The key of each key-value pair defines the column name. The key of each key-value pair defines the column name.
The value of each key-value pair defines the column value. The value of each key-value pair defines the column value.
_**Data type: Object**_ _**Data type:** Object_
## Examples ## Examples

View File

@ -39,11 +39,13 @@ experimental.subDuration(
### d ### d
The duration to subtract. The duration to subtract.
_**Data type: Duration**_ _**Data type:** Duration_
### from ### from
The time to subtract the [duration](#d) from. The time to subtract the [duration](#d) from.
_**Data type:** Time_
## Examples ## Examples
### Subtract six hours from a timestamp ### Subtract six hours from a timestamp

View File

@ -68,27 +68,27 @@ _[See the example below](#use-pivot-to-shape-data-for-experimental-to)._
The bucket to write data to. The bucket to write data to.
`bucket` and `bucketID` are mutually exclusive. `bucket` and `bucketID` are mutually exclusive.
_**Data type: String**_ _**Data type:** String_
### bucketID ### bucketID
The ID of the bucket to write data to. The ID of the bucket to write data to.
`bucketID` and `bucket` are mutually exclusive. `bucketID` and `bucket` are mutually exclusive.
_**Data type: String**_ _**Data type:** String_
### org ### org
The organization name of the specified [`bucket`](#bucket). The organization name of the specified [`bucket`](#bucket).
Only required when writing to a different organization or a remote host. Only required when writing to a different organization or a remote host.
`org` and `orgID` are mutually exclusive. `org` and `orgID` are mutually exclusive.
_**Data type: String**_ _**Data type:** String_
### orgID ### orgID
The organization ID of the specified [`bucket`](#bucket). The organization ID of the specified [`bucket`](#bucket).
Only required when writing to a different organization or a remote host. Only required when writing to a different organization or a remote host.
`orgID` and `org` are mutually exclusive. `orgID` and `org` are mutually exclusive.
_**Data type: String**_ _**Data type:** String_
## Examples ## Examples