Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 17c7876

Browse filesBrowse files
authored
fix: render README.rst at GitHub (influxdata#635)
* fix: render README.rst at GitHub Removed unsupported text role :class:. For more info see https://docutils.sourceforge.io/docs/ref/rst/roles.html * docs: update CHANGELOG.md
1 parent 4f1ab87 commit 17c7876
Copy full SHA for 17c7876

File tree

2 files changed

+14
-11
lines changed
Filter options

2 files changed

+14
-11
lines changed

‎CHANGELOG.md

Copy file name to clipboardExpand all lines: CHANGELOG.md
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
1. [#562](https://github.com/influxdata/influxdb-client-python/pull/562): Use `ThreadPoolScheduler` for `WriteApi`'s batch subject instead of `TimeoutScheduler` to prevent creating unnecessary threads repeatedly
88
1. [#631](https://github.com/influxdata/influxdb-client-python/pull/631): Logging HTTP requests without query parameters
99

10+
### Documentation
11+
1. [#635](https://github.com/influxdata/influxdb-client-python/pull/635): Fix render `README.rst` at GitHub
12+
1013
## 1.39.0 [2023-12-05]
1114

1215
### Features

‎README.rst

Copy file name to clipboardExpand all lines: README.rst
+11-11Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ Queries
626626
The result retrieved by `QueryApi <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/query_api.py>`_ could be formatted as a:
627627

628628
1. Flux data structure: `FluxTable <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/flux_table.py#L5>`_, `FluxColumn <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/flux_table.py#L22>`_ and `FluxRecord <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/flux_table.py#L31>`_
629-
2. :class:`~influxdb_client.client.flux_table.CSVIterator` which will iterate over CSV lines
629+
2. :code:`influxdb_client.client.flux_table.CSVIterator` which will iterate over CSV lines
630630
3. Raw unprocessed results as a ``str`` iterator
631631
4. `Pandas DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`_
632632

@@ -1403,12 +1403,12 @@ or use the ``[async]`` extra:
14031403

14041404
Async APIs
14051405
""""""""""
1406-
All async APIs are available via :class:`~influxdb_client.client.influxdb_client_async.InfluxDBClientAsync`.
1406+
All async APIs are available via :code:`influxdb_client.client.influxdb_client_async.InfluxDBClientAsync`.
14071407
The ``async`` version of the client supports following asynchronous APIs:
14081408

1409-
* :class:`~influxdb_client.client.write_api_async.WriteApiAsync`
1410-
* :class:`~influxdb_client.client.query_api_async.QueryApiAsync`
1411-
* :class:`~influxdb_client.client.delete_api_async.DeleteApiAsync`
1409+
* :code:`influxdb_client.client.write_api_async.WriteApiAsync`
1410+
* :code:`influxdb_client.client.query_api_async.QueryApiAsync`
1411+
* :code:`influxdb_client.client.delete_api_async.DeleteApiAsync`
14121412
* Management services into ``influxdb_client.service`` supports async operation
14131413

14141414
and also check to readiness of the InfluxDB via ``/ping`` endpoint:
@@ -1432,7 +1432,7 @@ and also check to readiness of the InfluxDB via ``/ping`` endpoint:
14321432
Async Write API
14331433
"""""""""""""""
14341434

1435-
The :class:`~influxdb_client.client.write_api_async.WriteApiAsync` supports ingesting data as:
1435+
The :code:`influxdb_client.client.write_api_async.WriteApiAsync` supports ingesting data as:
14361436

14371437
* ``string`` or ``bytes`` that is formatted as a InfluxDB's line protocol
14381438
* `Data Point <https://github.com/influxdata/influxdb-client-python/blob/master/influxdb_client/client/write/point.py#L16>`__ structure
@@ -1470,13 +1470,13 @@ The :class:`~influxdb_client.client.write_api_async.WriteApiAsync` supports inge
14701470
Async Query API
14711471
"""""""""""""""
14721472

1473-
The :class:`~influxdb_client.client.query_api_async.QueryApiAsync` supports retrieve data as:
1473+
The :code:`influxdb_client.client.query_api_async.QueryApiAsync` supports retrieve data as:
14741474

1475-
* List of :class:`~influxdb_client.client.flux_table.FluxTable`
1476-
* Stream of :class:`~influxdb_client.client.flux_table.FluxRecord` via :class:`~typing.AsyncGenerator`
1475+
* List of :code:`influxdb_client.client.flux_table.FluxTable`
1476+
* Stream of :code:`influxdb_client.client.flux_table.FluxRecord` via :code:`typing.AsyncGenerator`
14771477
* `Pandas DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`_
1478-
* Stream of `Pandas DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`_ via :class:`~typing.AsyncGenerator`
1479-
* Raw :class:`~str` output
1478+
* Stream of `Pandas DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`_ via :code:`typing.AsyncGenerator`
1479+
* Raw :code:`str` output
14801480

14811481
.. code-block:: python
14821482

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.