Skip to content

Commit dc95257

Browse files
authored
docs: clarify the unit of a parameter (#542)
1 parent df12e0b commit dc95257

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ The batching is configurable by ``write_options``\ :
427427
- Description
428428
- Default Value
429429
* - **batch_size**
430-
- the number of data pointx to collect in a batch
430+
- the number of data point to collect in a batch
431431
- ``1000``
432432
* - **flush_interval**
433433
- the number of milliseconds before the batch is written

influxdb_client/client/write_api.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,11 @@ def __init__(self, write_type: WriteType = WriteType.batching,
5757
5858
:param write_type: methods of write (batching, asynchronous, synchronous)
5959
:param batch_size: the number of data point to collect in batch
60-
:param flush_interval: flush data at least in this interval
60+
:param flush_interval: flush data at least in this interval (milliseconds)
6161
:param jitter_interval: this is primarily to avoid large write spikes for users running a large number of
62-
client instances ie, a jitter of 5s and flush duration 10s means flushes will happen every 10-15s.
63-
:param retry_interval: the time to wait before retry unsuccessful write
62+
client instances ie, a jitter of 5s and flush duration 10s means flushes will happen every 10-15s
63+
(milliseconds)
64+
:param retry_interval: the time to wait before retry unsuccessful write (milliseconds)
6465
:param max_retries: the number of max retries when write fails, 0 means retry is disabled
6566
:param max_retry_delay: the maximum delay between each retry attempt in milliseconds
6667
:param max_retry_time: total timeout for all retry attempts in milliseconds, if 0 retry is disabled

0 commit comments

Comments
 (0)