Note about backwards compatibility

spacetelescope · Feb 11, 2025 · bbb706b · bbb706b
1 parent 0cf2a0c
commit bbb706b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/astrocut/cutouts.py b/astrocut/cutouts.py
@@ -32,6 +32,9 @@ def fits_cut(input_files: List[Union[str, Path, S3Path]], coordinates: Union[Sky
     Note: No checking is done on either the WCS pointing or pixel scale. If images don't line up
     the cutouts will also not line up.
 
+    This function is maintained for backwards compatibility. For maximum flexibility, we recommend using
+    ``FITSCutout`` directly.
+
     Parameters
     ----------
     input_files : list
@@ -140,6 +143,9 @@ def img_cut(input_files: List[Union[str, Path, S3Path]], coordinates: Union[SkyC
     Note: No checking is done on either the WCS pointing or pixel scale. If images don't line up
     the cutouts will also not line up.
 
+    This function is maintained for backwards compatibility. For maximum flexibility, we recommend using
+    ``FITSCutout`` directly.
+
     Parameters
     ----------
     input_files : list