Merge remote-tracking branch 'origin/master'

JamesPImes · Apr 4, 2024 · d1e1bb3 · d1e1bb3
2 parents 91393a0 + ff91018
commit d1e1bb3
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/production_analyzer/data_loader.py b/production_analyzer/data_loader.py
@@ -411,8 +411,11 @@ def get_html(self, url) -> str:
 
     def save_html(self, txt, fp):
         """
-        Save the HTML to the specified filename (if ``.save_html_dir``
-        has been configured).
+        Save the HTML (``txt``) to the specified filepath (``fp``).
+
+        .. warning::
+
+            This will overwrite any file at ``fp`` without warning.
         """
         fp = Path(fp)
         os.makedirs(fp.parent, exist_ok=True)
@@ -423,7 +426,12 @@ def save_html(self, txt, fp):
 
     def save_csv(self, df, fp) -> None:
         """
-        Save the production ``DataFrame`` to .csv.
+        Save the production ``DataFrame`` (``df``) to .csv at the
+        specified filepath ``fp``.
+
+        .. warning::
+
+            This will overwrite any file at ``fp`` without warning.
         """
         fp = Path(fp)
         os.makedirs(fp.parent, exist_ok=True)