Skip to content

Commit

Permalink
Updated docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jchabloz committed Jan 1, 2024
1 parent b4b8ff3 commit 8be4d0a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions python/verisocks/verisocks.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,10 +376,10 @@ def run(self, cb, **kwargs):
Note:
The parameter `cb` can be either:
* ``"for_time"``: run for a given amount of time
* ``"until_time"``: run until a specified time
* ``"until_change"``: run until a specific value changes
* ``"to_next"``: run until the beginning of the next time step
* ``"for_time"``: run for a given amount of time
* ``"until_time"``: run until a specified time
* ``"until_change"``: run until a specific value changes
* ``"to_next"``: run until the beginning of the next time step
If `cb` is ``"for_time"`` or ``"until_time"``, the following
keyword arguments are further expected:
Expand All @@ -392,10 +392,10 @@ def run(self, cb, **kwargs):
If `cb` is ``"until_change"``, the following keyword argument(s)
are further expected:
* **path** (str): Path to verilog object used for the callback
* **value** (number): Condition on the verilog object's
value for the callback to be executed. This argument is not
required if the path corresponds to a named event.
* **path** (str): Path to verilog object used for the callback
* **value** (number): Condition on the verilog object's
value for the callback to be executed. This argument is not
required if the path corresponds to a named event.
If `cb` is ``"to_next"``, no further keyword argument is required.
"""
Expand Down

0 comments on commit 8be4d0a

Please sign in to comment.