DEP: Add deprecation warning to generate_aggregation_metadata() (equi…

…nor#831)
mferrera · Oct 3, 2024 · 578ec03 · 578ec03
1 parent 41b7b0f
commit 578ec03
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/src/dataio_3_migration.rst b/docs/src/dataio_3_migration.rst
@@ -302,3 +302,6 @@ Changes to input arguments
 Changes to method arguments  
  - The ``skip_null`` argument to ``generate_metadata()`` is deprecated. It is redundant and can be removed.
 
+Deprecated methods
+ - The ``generate_aggregation_metadata()`` method is deprecated. Replace it with the identical 
+   ``generate_metadata()`` method instead.
diff --git a/src/fmu/dataio/aggregation.py b/src/fmu/dataio/aggregation.py
@@ -346,6 +346,11 @@ def generate_aggregation_metadata(
         **kwargs: object,
     ) -> dict:
         """Alias method name, see ``generate_metadata``"""
+        warnings.warn(
+            "This method is deprecated and will be removed in the future. "
+            "Use the 'generate_metadata()' method directly instead.",
+            FutureWarning,
+        )
         return self.generate_metadata(
             obj, compute_md5=compute_md5, skip_null=skip_null, **kwargs
         )