wip: update documentation on camera

GazzolaLab · Sep 18, 2024 · e6afde9 · e6afde9
1 parent cc158bb
commit e6afde9
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/bsr/_camera.py b/src/bsr/_camera.py
@@ -252,6 +252,18 @@ def get_file_path(
     ) -> str:
         """
         Get the file path for rendering.
+
+        Parameters
+        ----------
+        frame : int, optional
+            The frame number. Default is None.
+        number_of_digits : int, optional
+            The number of digits for the frame number. Default is 4.
+
+        Returns
+        -------
+        str
+            The file path for rendering.
         """
         # check if the render file path is set
         assert (
@@ -282,6 +294,11 @@ def render(
     ) -> None:
         """
         Render the scene.
+
+        Parameters
+        ----------
+        frames : int, list, tuple or np.array, optional
+            The frames to render. Default is None.
         """
         frame_manager = FrameManager()