Skip to content

Commit 2323cfe

Browse files
committed
[py] apply code review suggestions / docs improvement (#3151)
Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com> [py] Apply suggestions from code review Co-authored-by: Leonid Ryzhyk <ryzhyk@gmail.com> Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com> [py] docs: apply suggestions from code review Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
1 parent 0fb49a5 commit 2323cfe

File tree

5 files changed

+156
-91
lines changed

5 files changed

+156
-91
lines changed

python/docs/examples.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,22 @@ Connecting to Feldera on localhost
3636
Setting HTTP Connection Timeouts
3737
================================
3838

39+
To set a timeout for the HTTP connection, pass the timeout parameter to the `.class:FelderaClient` constructor.
40+
If the Feldera backend server takes longer than the specified timeout to respond, a
41+
`.class:FelderaTimeoutError` exception will be raised.
42+
This example sets the timeout for each HTTP request to 10 seconds.
43+
3944
.. code-block:: python
4045
4146
from feldera import FelderaClient, PipelineBuilder
4247
4348
client = FelderaClient("http://localhost:8080", api_key=api_key, timeout=10)
4449
50+
.. note::
51+
This is for an individual HTTP request, and does not affect things like waiting for a pipeline to start,
52+
pause, resume and shutdown.
53+
To set a timeout for these state transitions, set the parameter `timeout_s` in respective functions.
54+
4555
Creating a Pipeline (OVERWRITING existing pipelines)
4656
====================================================
4757

0 commit comments

Comments
 (0)