From cd5fe76754958dce529c901d74e77f0e19625c41 Mon Sep 17 00:00:00 2001
From: Rahul Mahajan <aerorahul@users.noreply.github.com>
Date: Wed, 11 Sep 2024 11:14:27 -0400
Subject: [PATCH] add deprecation note for `copy`

---
 src/wxflow/file_utils.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/wxflow/file_utils.py b/src/wxflow/file_utils.py
index 27e429b..967a023 100644
--- 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):