Add relative dt to the docstring examples of the read_data function

precice · Jul 21, 2024 · 45b3ecc · 45b3ecc
1 parent 624f1fa
commit 45b3ecc
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/cyprecice/cyprecice.pyx b/cyprecice/cyprecice.pyx
@@ -818,23 +818,26 @@ cdef class Participant:
         >>> mesh_name = "MeshOne"
         >>> data_name = "DataOne"
         >>> vertex_ids = [1, 2, 3, 4, 5]
-        >>> values = read_data(mesh_name, data_name, vertex_ids)
+        >>> dt = 1.0
+        >>> values = read_data(mesh_name, data_name, vertex_ids, dt)
         >>> values.shape
         >>> (5, )
 
         Read vector data for a 2D problem with 5 vertices:
         >>> mesh_name = "MeshOne"
         >>> data_name = "DataOne"
         >>> vertex_ids = [1, 2, 3, 4, 5]
-        >>> values = read_data(mesh_name, data_name, vertex_ids)
+        >>> dt = 1.0
+        >>> values = read_data(mesh_name, data_name, vertex_ids, dt)
         >>> values.shape
         >>> (5, 2)
 
         Read vector data for a 3D system with 5 vertices:
         >>> mesh_name = "MeshOne"
         >>> data_name = "DataOne"
         >>> vertex_ids = [1, 2, 3, 4, 5]
-        >>> values = read_data(mesh_name, data_name, vertex_ids)
+        >>> dt = 1.0
+        >>> values = read_data(mesh_name, data_name, vertex_ids, dt)
         >>> values.shape
         >>> (5, 3)
         """