From 578ec031ea2a5f7c28ab32dcdfc5146f0a7fc346 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Therese=20Natter=C3=B8y?=
 <61694854+tnatt@users.noreply.github.com>
Date: Thu, 3 Oct 2024 09:02:20 +0200
Subject: [PATCH] DEP: Add deprecation warning to
 generate_aggregation_metadata() (#831)

---
 docs/src/dataio_3_migration.rst | 3 +++
 src/fmu/dataio/aggregation.py   | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/docs/src/dataio_3_migration.rst b/docs/src/dataio_3_migration.rst
index a82da6bc7..f95fa2a6a 100644
--- 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
index 56bca216b..48185a18d 100644
--- 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
         )