Переглянути джерело

fix: update break line on docstring

trgiangdo 10 місяців тому
батько
коміт
3a18d68ef4

+ 4 - 4
taipy/core/_orchestrator/_orchestrator.py

@@ -65,8 +65,8 @@ class _Orchestrator(_AbstractOrchestrator):
              wait (bool): Wait for the orchestrated jobs created from the scenario or sequence submission to be
                 finished in asynchronous mode.
              timeout (Union[float, int]): The optional maximum number of seconds to wait for the jobs to be finished
-                before returning.
-                If not provided and wait is True, the function waits indefinitely.
+                before returning.<br/>
+                If not provided and *wait* is True, the function waits indefinitely.
              **properties (dict[str, any]): A key worded variable length list of user additional arguments
                 that will be stored within the `Submission^`. It can be accessed via `Submission.properties^`.
         Returns:
@@ -120,8 +120,8 @@ class _Orchestrator(_AbstractOrchestrator):
              wait (bool): Wait for the orchestrated job created from the task submission to be finished
                 in asynchronous mode.
              timeout (Union[float, int]): The optional maximum number of seconds to wait for the job
-                to be finished before returning.
-                If not provided and wait is True, the function waits indefinitely.
+                to be finished before returning.<br/>
+                If not provided and *wait* is True, the function waits indefinitely.
              **properties (dict[str, any]): A key worded variable length list of user additional arguments
                 that will be stored within the `Submission^`. It can be accessed via `Submission.properties^`.
         Returns:

+ 2 - 2
taipy/core/scenario/scenario.py

@@ -608,8 +608,8 @@ class Scenario(_Entity, Submittable, _Labeled):
             wait (bool): Wait for the orchestrated jobs created from the scenario submission to be finished in
                 asynchronous mode.
             timeout (Union[float, int]): The optional maximum number of seconds to wait for the jobs to be finished
-                before returning.
-                If not provided and wait is True, the function waits indefinitely.
+                before returning.<br/>
+                If not provided and *wait* is True, the function waits indefinitely.
             **properties (dict[str, any]): A keyworded variable length list of additional arguments.
         Returns:
             A `Submission^` containing the information of the submission.

+ 2 - 2
taipy/core/sequence/sequence.py

@@ -311,8 +311,8 @@ class Sequence(_Entity, Submittable, _Labeled):
             wait (bool): Wait for the orchestrated jobs created from the sequence submission to be finished
                 in asynchronous mode.
             timeout (Union[float, int]): The maximum number of seconds to wait for the jobs to be finished before
-                returning.
-                If not provided and wait is True, the function waits indefinitely.
+                returning.<br/>
+                If not provided and *wait* is True, the function waits indefinitely.
             **properties (dict[str, any]): A keyworded variable length list of additional arguments.
         Returns:
             A `Submission^` containing the information of the submission.

+ 2 - 2
taipy/core/taipy.py

@@ -240,8 +240,8 @@ def submit(
         wait (bool): Wait for the orchestrated jobs created from the submission to be finished
             in asynchronous mode.
         timeout (Union[float, int]): The optional maximum number of seconds to wait
-            for the jobs to be finished before returning.
-            If not provided and wait is True, the function waits indefinitely.
+            for the jobs to be finished before returning.<br/>
+            If not provided and *wait* is True, the function waits indefinitely.
         **properties (dict[str, any]): A key-worded variable length list of user additional arguments
             that will be stored within the `Submission^`. It can be accessed via `Submission.properties^`.
 

+ 2 - 2
taipy/core/task/task.py

@@ -231,8 +231,8 @@ class Task(_Entity, _Labeled):
             wait (bool): Wait for the orchestrated job created from the task submission to be finished in asynchronous
                 mode.
             timeout (Union[float, int]): The maximum number of seconds to wait for the job to be finished before
-                returning.
-                If not provided and wait is True, the function waits indefinitely.
+                returning.<br/>
+                If not provided and *wait* is True, the function waits indefinitely.
             **properties (dict[str, any]): A keyworded variable length list of additional arguments.
         Returns:
             A `Submission^` containing the information of the submission.