Skip to content

Commit bd17966

Browse files
committed
Fix names of environment variables in docs.
1 parent 1e62b3c commit bd17966

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/reference/variables.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -54,29 +54,30 @@ Reconnection
5454

5555
Reconnection attempts are spaced out with truncated exponential backoff.
5656

57-
.. envvar:: BACKOFF_INITIAL_DELAY
57+
.. envvar:: WEBSOCKETS_BACKOFF_INITIAL_DELAY
5858

5959
The first attempt is delayed by a random amount of time between ``0`` and
60-
``BACKOFF_INITIAL_DELAY`` seconds.
60+
``WEBSOCKETS_BACKOFF_INITIAL_DELAY`` seconds.
6161

6262
The default value is ``5.0`` seconds.
6363

64-
.. envvar:: BACKOFF_MIN_DELAY
64+
.. envvar:: WEBSOCKETS_BACKOFF_MIN_DELAY
6565

66-
The second attempt is delayed by ``BACKOFF_MIN_DELAY`` seconds.
66+
The second attempt is delayed by ``WEBSOCKETS_BACKOFF_MIN_DELAY`` seconds.
6767

6868
The default value is ``3.1`` seconds.
6969

70-
.. envvar:: BACKOFF_FACTOR
70+
.. envvar:: WEBSOCKETS_BACKOFF_FACTOR
7171

72-
After the second attempt, the delay is multiplied by ``BACKOFF_FACTOR``
73-
between each attempt.
72+
After the second attempt, the delay is multiplied by
73+
``WEBSOCKETS_BACKOFF_FACTOR`` between each attempt.
7474

7575
The default value is ``1.618``.
7676

77-
.. envvar:: BACKOFF_MAX_DELAY
77+
.. envvar:: WEBSOCKETS_BACKOFF_MAX_DELAY
7878

79-
The delay between attempts is capped at ``BACKOFF_MAX_DELAY`` seconds.
79+
The delay between attempts is capped at ``WEBSOCKETS_BACKOFF_MAX_DELAY``
80+
seconds.
8081

8182
The default value is ``90.0`` seconds.
8283

0 commit comments

Comments
 (0)