Wrapping/Python: replace section syntax in docstrings

Kitware · Feb 20, 2025 · 971e436 · 971e436
1 parent 3def5f7
commit 971e436
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 12 deletions.
diff --git a/Wrapping/Python/paraview/algorithms/openpmd.py b/Wrapping/Python/paraview/algorithms/openpmd.py
@@ -119,8 +119,7 @@ def _get_update_time(self, outInfo):
           https://github.com/openPMD/openPMD-viewer/pull/347
         - or move out of the reader into VTK itself, so all readers behave the same
 
-        Parameters
-        ----------
+        Parameters:
 
         outInfo: vktInformation
           Exchanges information between pipeline objects, e.g., between two filters.
@@ -129,8 +128,8 @@ def _get_update_time(self, outInfo):
 
           UPDATE_... are requests. Here, we request a new step for a time, e.g., to animate.
 
-        Returns
-        -------
+        Returns:
+
           The time (float) of the first time step available
           that is less than the requested time.
         """
@@ -232,8 +231,7 @@ def FillOutputPortInformation(self, port, info):
         - vtkPartitionedDataSet: openPMD meshes
         - vtkPartitionedDataSetCollection: openPMD particle species
 
-        Parameters
-        ----------
+        Parameters:
 
         port: Int
           Output indices: 0 for meshes, 1 for particle species
@@ -257,8 +255,8 @@ def RequestInformation(self, request, inInfoVec, outInfoVec):
         - species names
         - particle array names per species
 
-        Parameters
-        ----------
+        Parameters:
+
         request:
           Not used.
 
@@ -378,8 +376,8 @@ def _get_array_and_component(self, itr, name):
         Scalars have no components, e.g., a density field "rho".
         Vectors/tensors have components, e.g., the electric field E ("E_x", "E_y", "E_z").
 
-        Parameters
-        ----------
+        Parameters:
+
         itr: openPMD.Iteration
           The current iteration to inspect.
         name: openPMD record name of the mesh, e.g., "rho" or "E_x"

diff --git a/Wrapping/Python/paraview/simple/camera.py b/Wrapping/Python/paraview/simple/camera.py
@@ -41,8 +41,7 @@ def ResetCameraToDirection(
     :param sbounds: If provided, reset the camera using computed bounds from a sphere_bounds (center_x, center_y, center_z, radius).
     :type sbounds: 4-element tuple or list of floats.
 
-    Examples
-    --------
+    Examples:
 
     >> ResetCameraToDirection(
     ...   direction=[-1, -1, -1],