added docstring

bessagroup · Nov 18, 2023 · 0b27c2d · 0b27c2d
1 parent f488cfd
commit 0b27c2d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git 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)