diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 1c4c3c8..a5b1bce 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -51,7 +51,7 @@ To start a shell, run: Handling connection timeouts. ----------------------------- -You can specify an optional :code:`timeout=` parameter on both `Query` and `RCON` clients. +You can specify an optional :code:`timeout=` parameter to allow a connection attempt to time out. If a timeout is reached during a connection attempt, it will raise a `socket.timeout `_ exception. The following example will raise a connection timeout after 1.5 seconds: