Merge pull request #516 from influxdata/flux/format-fixes

Fixed formatting of data types throughout Flux function docs
pull/530/head
Scott Anderson 2019-10-14 10:45:19 -06:00 committed by GitHub
commit 3a6c70f8f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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
The period or number of points to use in the calculation.
_**Data type: Integer**_
_**Data type:** Integer_
### columns
The columns to operate on.

View File

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

View File

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

View File

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

View File

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

View File

@ -39,11 +39,13 @@ experimental.addDuration(
### d
The duration to add.
_**Data type: Duration**_
_**Data type:** Duration_
### to
The time to add the [duration](#d) to.
_**Data type:** Time_
## Examples
### 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)
- [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
The project ID of the Cloud Bigtable project to retrieve data from.
_**Data type: String**_
_**Data type:** String_
### instance
The instance ID of the Cloud Bigtable instance to retrieve data from.
_**Data type: String**_
_**Data type:** String_
### table
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
The MQTT broker connection string.
_**Data type: String**_
_**Data type:** String_
### topic
The MQTT topic to send data to.
_**Data type: String**_
_**Data type:** String_
### message
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).
{{% /note %}}
_**Data type: String**_
_**Data type:** String_
### qos
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]`.
Default is `0`.
_**Data type: Integer**_
_**Data type:** Integer_
### clientid
The MQTT client ID.
_**Data type: String**_
_**Data type:** String_
### username
The username to send to the MQTT broker.
Username is only required if the broker requires authentication.
If you provide a username, you must provide a [password](#password).
_**Data type: String**_
_**Data type:** String_
### password
The password to send to the MQTT broker.
Password is only required if the broker requires authentication.
If you provide a password, you must provide a [username](#username).
_**Data type: String**_
_**Data type:** String_
### name
_(Optional)_ The name for the MQTT message.
_**Data type: String**_
_**Data type:** String_
### timeout
The MQTT connection timeout.
Default is `1s`.
_**Data type: Duration**_
_**Data type:** Duration_
### timeColumn
The column to use as time values in the output line protocol.
Default is `"_time"`.
_**Data type: String**_
_**Data type:** String_
### tagColumns
The columns to use as tag sets in the output line protocol.

View File

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

View File

@ -36,7 +36,7 @@ prometheus.scrape(
### url
The URL to scrape Prometheus-formatted metrics from.
_**Data type: String**_
_**Data type:** String_
## 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 value of each key-value pair defines the column value.
_**Data type: Object**_
_**Data type:** Object_
## Examples

View File

@ -39,11 +39,13 @@ experimental.subDuration(
### d
The duration to subtract.
_**Data type: Duration**_
_**Data type:** Duration_
### from
The time to subtract the [duration](#d) from.
_**Data type:** Time_
## Examples
### 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.
`bucket` and `bucketID` are mutually exclusive.
_**Data type: String**_
_**Data type:** String_
### bucketID
The ID of the bucket to write data to.
`bucketID` and `bucket` are mutually exclusive.
_**Data type: String**_
_**Data type:** String_
### org
The organization name of the specified [`bucket`](#bucket).
Only required when writing to a different organization or a remote host.
`org` and `orgID` are mutually exclusive.
_**Data type: String**_
_**Data type:** String_
### orgID
The organization ID of the specified [`bucket`](#bucket).
Only required when writing to a different organization or a remote host.
`orgID` and `org` are mutually exclusive.
_**Data type: String**_
_**Data type:** String_
## Examples