update docstrings as suggested in PR for sandialabs#82

braden6521 · Jun 17, 2024 · f9bc2ec · f9bc2ec
1 parent 171f3b2
commit f9bc2ec
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py b/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py
@@ -16,6 +16,11 @@
 
 
 class View3dImageProcessor(AbstractSpotAnalysisImagesProcessor):
+    """
+    Interprets the current image as a 3D surface plot and either displays it, or if interactive it displays the surface
+    and waits on the next press of the "enter" key.
+    """
+
     def __init__(
         self,
         label: str | rca.RenderControlAxis = 'Light Intensity',
@@ -24,9 +29,6 @@ def __init__(
         crop_to_threshold: int | None = None,
     ):
         """
-        Interprets the current image as a 3D surface plot and either displays it, or if interactive it displays the
-        surface and waits on the next press of the "enter" key.
-
         Parameters
         ----------
         label : str | rca.RenderControlAxis, optional