From 971e436293639bcb1ac19f3167bb616b595e04e7 Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Thu, 20 Feb 2025 13:34:48 +0100 Subject: [PATCH] Wrapping/Python: replace section syntax in docstrings --- Wrapping/Python/paraview/algorithms/openpmd.py | 18 ++++++++---------- Wrapping/Python/paraview/simple/camera.py | 3 +-- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/Wrapping/Python/paraview/algorithms/openpmd.py b/Wrapping/Python/paraview/algorithms/openpmd.py index 867786da3c4..a3cb6d362ff 100644 --- 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 index 469739727bb..0db2da7e3eb 100644 --- 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],