common/lib/opencsp_path: Test docs

sandialabs · Jan 17, 2025 · 3ade656 · 3ade656
1 parent 8104941
commit 3ade656
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/opencsp/common/lib/opencsp_path/data_path_for_test.py b/opencsp/common/lib/opencsp_path/data_path_for_test.py
@@ -19,8 +19,32 @@ def __sandia_nsttf_test_definition_dir():
 
 
 def sandia_nsttf_test_heliostats_origin_file():
+    """
+    Returns the path to the heliostats origin file for the Sandia NSTTF tests.
+
+    This file contains data regarding the origin positions of heliostats at the Sandia
+    National Solar Thermal Test Facility.
+
+    Returns
+    -------
+    str
+        The path to the heliostats origin file.
+    """
+    # "ChatGPT 4o" assisted with generating this docstring.
     return os.path.join(__sandia_nsttf_test_definition_dir(), 'NSTTF_Heliostats_origin_at_torque_tube.csv')
 
 
 def sandia_nsttf_test_facet_centroidsfile():
+    """
+    Returns the path to the facet centroids file for the Sandia NSTTF tests.
+
+    This file contains data regarding the centroids of facets at the Sandia National
+    Solar Thermal Test Facility.
+
+    Returns
+    -------
+    str
+        The path to the facet centroids file.
+    """
+    # "ChatGPT 4o" assisted with generating this docstring.
     return os.path.join(__sandia_nsttf_test_definition_dir(), 'NSTTF_Facet_Centroids.csv')