Added docstring

sandialabs · Mar 18, 2024 · a802ab6 · a802ab6
1 parent 42cc5a4
commit a802ab6
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/opencsp/app/sofast/lib/ProcessSofastFringe.py b/opencsp/app/sofast/lib/ProcessSofastFringe.py
@@ -737,6 +737,15 @@ def get_optic(
             return facets[0]
 
     def save_to_hdf(self, file: str, prefix: str = ''):
+        """Saves data to given file. Data is stored as: PREFIX + Folder/Field_1
+
+        Parameters
+        ----------
+        file : str
+            HDF file to save to
+        prefix : str
+            Prefix to append to folder path within HDF file (folders must be separated by "/")
+        """
         # Log
         lt.info(f'Saving SofastFringe data to: {file:s}, in HDF5 folder: "{prefix:s}"')