From 0b27c2d47780ac702a6b0891cb246ad03a8b381f Mon Sep 17 00:00:00 2001
From: Martin van der Schelling
 <61459087+mpvanderschelling@users.noreply.github.com>
Date: Fri, 17 Nov 2023 21:41:03 -0500
Subject: [PATCH] added docstring

---
 src/f3dasm/_src/experimentdata/experimentsample.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/f3dasm/_src/experimentdata/experimentsample.py b/src/f3dasm/_src/experimentdata/experimentsample.py
index 3f8ba0be..c7973272 100644
--- a/src/f3dasm/_src/experimentdata/experimentsample.py
+++ b/src/f3dasm/_src/experimentdata/experimentsample.py
@@ -288,6 +288,18 @@ def _store_to_experimentdata(self, object: Any, name: str) -> None:
 def _experimentsample_factory(
     experiment_sample: np.ndarray | ExperimentSample | Dict) \
         -> ExperimentSample:
+    """Factory function for the ExperimentSample class.
+
+    Parameters
+    ----------
+    experiment_sample : np.ndarray | ExperimentSample | Dict
+        The experiment sample to convert to an ExperimentSample.
+
+    Returns
+    -------
+    ExperimentSample
+        The converted experiment sample.
+    """
     if isinstance(experiment_sample, np.ndarray):
         return ExperimentSample.from_numpy(experiment_sample)