Skip to content

Commit c0764d0

Browse files
committed
Improved API doc
1 parent 1f699b9 commit c0764d0

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/InfluxDbClient.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ class Point {
106106
void putField(String name, String value);
107107
};
108108
/**
109-
* InfluxDBClient handles connection and basic operations for InfluxDB 2 server
110-
* It provides write API with ability to write data in batches, retrying failure writes, smart optimization and simple Flux querying
109+
* InfluxDBClient handles connection and basic operations for an InfluxDB server.
110+
* It provides write API with ability to write data in batches and retrying failed writes.
111111
* Automaticaly retries failed writes during next write, if server is overloaded.
112112
*/
113113
class InfluxDBClient {
@@ -142,7 +142,7 @@ class InfluxDBClient {
142142
// Data are written either when number of points in buffer reaches batchSize or time of
143143
// preserveConnection - true if HTTP connection should be kept open. Usable for often writes.
144144
void setWriteOptions(WritePrecision precision, uint16_t batchSize = 1, uint16_t bufferSize = 5, uint16_t flushInterval = 60, bool preserveConnection = true);
145-
// Sets InfluxDBClient connection parameters
145+
// Sets connection parameters for InfluxDB 2
146146
// serverUrl - url of the InfluxDB 2 server (e.g. https//localhost:9999)
147147
// org - name of the organization, which bucket belongs to
148148
// bucket - name of the bucket to write data into

0 commit comments

Comments
 (0)