Skip to content

Commit 9c0ab25

Browse files
committed
Fix inaccurate timeout docstring
The docstring on the `timeout` config key implies that if no value for a timeout is provided, initilization will block forever. This disagrees with the `DeciderContextFactory` docstring (`"defaults to not blocking"`) and the underlying Baseplate `FileWatcher` ([source](https://github.com/reddit/baseplate.py/blob/f29bd1ce0f1ec4962f65ecd5a2b016b1cd4fd5ac/baseplate/lib/file_watcher.py#L82)). We've also seen this not block in production. Logs can be provided if needed.
1 parent 171b5fe commit 9c0ab25

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

reddit_decider/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ def decider_client_from_config(
11651165
experiment configuration fetcher daemon.
11661166
``timeout`` (optional)
11671167
The time that we should wait for the file specified by ``path`` to
1168-
exist. Defaults to `None` which is `infinite`.
1168+
exist. Defaults to `None` which is not blocking.
11691169
``backoff`` (optional)
11701170
The base amount of time for exponential backoff when trying to find the
11711171
experiments config file. Defaults to no backoff between tries.

0 commit comments

Comments
 (0)