add deprecation note for copy

NOAA-EMC · Sep 11, 2024 · cd5fe76 · cd5fe76
1 parent 63d23ee
commit cd5fe76
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/wxflow/file_utils.py b/src/wxflow/file_utils.py
@@ -27,6 +27,11 @@ class FileHandler:
     ----------
     config : dict
             Dictionary of files to manipulate
+
+    NOTE
+    ----
+    `copy` will be deprecated in the future in favor of `copy_req` and `copy_opt`
+    Users are encouraged to use `copy_req` and `copy_opt` instead of `copy`
     """
 
     def __init__(self, config):