Adds docs to local backend class on how to change path

DAGWorks-Inc · Sep 4, 2024 · 34c68fe · 34c68fe
1 parent 8f9e503
commit 34c68fe
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/burr/tracking/server/backend.py b/burr/tracking/server/backend.py
@@ -189,9 +189,10 @@ def get_uri(project_id: str) -> str:
 
 
 class LocalBackend(BackendBase):
-    """Quick implementation of a local backend for testing purposes. This is not a production backend."""
+    """Quick implementation of a local backend for testing purposes. This is not a production backend.
 
-    # TODO -- make this configurable through an env variable
+    To override the path, set a `burr_path` environment variable to the path you want to use.
+    """
 
     def __init__(self, path: str = DEFAULT_PATH):
         self.path = path