From 16b84f33f65b8211263feee1b200f8fbbefe408a Mon Sep 17 00:00:00 2001
From: James Bristow <jbris@users.noreply.github.com>
Date: Tue, 10 Sep 2024 16:33:03 +1200
Subject: [PATCH] Adding missing ArangoDb comment docs

---
 deeprootgen/io/simulation_data.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/deeprootgen/io/simulation_data.py b/deeprootgen/io/simulation_data.py
index 8fd8ac3..1ac36ff 100644
--- a/deeprootgen/io/simulation_data.py
+++ b/deeprootgen/io/simulation_data.py
@@ -43,6 +43,16 @@ def s3_upload_file(file_name: str, object_name: str, bucket_name: str = "data")
 def save_graph_to_db(
     simulation: RootSystemSimulation, task: str, simulation_uuid: str
 ) -> None:
+    """Save the hierarchical graph representation of the root model to ArangoDB.
+
+    Args:
+        simulation (RootSystemSimulation):
+            The root system simulation instance.
+        task (str):
+            The current simulation task.
+        simulation_uuid (str):
+            The simulation uuid.
+    """
     G = simulation.G.as_networkx()
     collection = f"{task}-{simulation_uuid}"