From 6a7297d15852278ad9be114031413c83968744ee Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 11 Mar 2022 10:33:14 +0100
Subject: [PATCH] DOC: Document the `timeout` option.

---
 examples/pycaosdb.ini    | 3 +++
 src/doc/configuration.md | 2 ++
 2 files changed, 5 insertions(+)

diff --git a/examples/pycaosdb.ini b/examples/pycaosdb.ini
index edc32195..8cf74e43 100644
--- a/examples/pycaosdb.ini
+++ b/examples/pycaosdb.ini
@@ -67,3 +67,6 @@
 
 # This option is used internally and for testing. Do not override.
 # implementation=_DefaultCaosDBServerConnection
+
+# The timeout for requests to the server.
+# timeout=1000
diff --git a/src/doc/configuration.md b/src/doc/configuration.md
index 6e53542f..802da4e9 100644
--- a/src/doc/configuration.md
+++ b/src/doc/configuration.md
@@ -49,6 +49,8 @@ with CaosDB which makes the experience much less verbose. Set it to 1 or 2 in ca
 debugging (which I hope will not be necessary for this tutorial) or if you want to learn more about
 the internals of the protocol. 
 
+`timeout` sets the timeout for requests to the server.
+
 A complete list of options can be found in the 
 [pycaosdb.ini file](https://gitlab.com/caosdb/caosdb-pylib/-/blob/main/examples/pycaosdb.ini) in 
 the examples folder of the source code.
-- 
GitLab