From 692865fa2659b94dfb072634b555b7369e22775f Mon Sep 17 00:00:00 2001
From: Timothy Willard <9395586+TimothyWillard@users.noreply.github.com>
Date: Tue, 10 Dec 2024 10:24:36 -0500
Subject: [PATCH] Document `ModelInfo.get_seeding_data`

---
 flepimop/gempyor_pkg/src/gempyor/model_info.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/flepimop/gempyor_pkg/src/gempyor/model_info.py b/flepimop/gempyor_pkg/src/gempyor/model_info.py
index d5e040f33..459598ab6 100644
--- a/flepimop/gempyor_pkg/src/gempyor/model_info.py
+++ b/flepimop/gempyor_pkg/src/gempyor/model_info.py
@@ -355,6 +355,18 @@ def write_simID(
         return fname
 
     def get_seeding_data(self, sim_id: int) -> tuple[nb.typed.Dict, npt.NDArray[np.number]]:
+        """
+        Pull the seeding data for the info represented by this model info instance.
+
+        Args:
+            sim_id: The simulation ID to pull seeding data for.
+
+        Returns:
+            A tuple containing the seeding data dictionary and the seeding data array.
+
+        See Also:
+            `gempyor.seeding.Seeding.get_from_config`
+        """
         return self.seeding.get_from_config(
             self.compartments,
             self.subpop_struct,