Debug docstrings

tum-esm · Nov 17, 2024 · 5b8cb9a · 5b8cb9a
1 parent 72a871a
commit 5b8cb9a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/docs/pages/api-reference.md b/docs/pages/api-reference.md
@@ -1290,11 +1290,13 @@ Exponential backoff e.g. when errors occur. First try again in 1 minute,
 then 4 minutes, then 15 minutes, etc.. Usage:
 
 ```python
-import src
-exponential_backoff = ExponentialBackoff(logger.info)
+exponential_backoff = ExponentialBackoff(
+    log_info=logger.info, buckets= [60, 240, 900, 3600, 14400]
+)
+
 while True:
     try:
-        # do something
+        # do something that might fail
         exponential_backoff.reset()
     except Exception as e:
         logger.exception(e)

diff --git a/tum_esm_utils/timing.py b/tum_esm_utils/timing.py
@@ -266,11 +266,13 @@ class ExponentialBackoff:
     then 4 minutes, then 15 minutes, etc.. Usage:
     
     ```python
-    import src
-    exponential_backoff = ExponentialBackoff(logger.info)
+    exponential_backoff = ExponentialBackoff(
+        log_info=logger.info, buckets= [60, 240, 900, 3600, 14400]
+    )
+
     while True:
         try:
-            # do something
+            # do something that might fail
             exponential_backoff.reset()
         except Exception as e:
             logger.exception(e)