Skip to content

Commit eb7e329

Browse files
committed
minor doc tweaks
1 parent 01768e2 commit eb7e329

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and full-connection encryption with
1818
Quickstart
1919
==========
2020

21-
The latest version of the library is 2.0.1.
21+
The latest version of the library is 2.0.1 (`changelog <https://py-questdb-client.readthedocs.io/en/latest/changelog.html>`_).
2222

2323
::
2424

docs/sender.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,9 @@ You can also specify the configuration parameters programmatically:
587587
...
588588
589589
590+
See the :ref:`sender_conf` section for a full list of configuration parameters:
591+
each configuration parameter can be passed as named arguments to the constructor.
592+
590593
Python type mappings:
591594

592595
* Parameters that require strings take a ``str``.
@@ -600,6 +603,11 @@ Python type mappings:
600603

601604
* Paths can also be specified as a ``pathlib.Path``.
602605

606+
.. note::
607+
608+
The constructor arguments have changed between 1.x and 2.x.
609+
If you are upgrading, take a look at the :ref:`changelog <changelog>`.
610+
603611
Customising ``.from_conf()`` and ``.from_env()``
604612
------------------------------------------------
605613

0 commit comments

Comments
 (0)