docs: correct sim tool doc messages

Remove stale arguments and add missing information.

Signed-off-by: Alex Jones <alex.jones@lowrisc.org>

Author: AlexJones0

src/dvsim/sim/tool/base.py

@@ -44,11 +44,13 @@ def get_job_runtime(log_text: Sequence[str]) -> tuple[float, str]:
 
         Args:
             log_text: is the job's log file contents as a list of lines.
-            tool: is the EDA tool used to run the job.
 
         Returns:
             a tuple of (runtime, units).
 
+        Raises:
+            RuntimeError: exception if the search pattern is not found.
+
         """
         ...
 
@@ -65,7 +67,7 @@ def get_simulated_time(log_text: Sequence[str]) -> tuple[float, str]:
             log_text: is the job's log file contents as a list of lines.
 
         Returns:
-            the simulated, units as a tuple.
+            a tuple of (simulated time, units).
 
         Raises:
             RuntimeError: exception if the search pattern is not found.

src/dvsim/sim/tool/vcs.py

@@ -65,11 +65,13 @@ def get_job_runtime(log_text: Sequence[str]) -> tuple[float, str]:
 
         Args:
             log_text: is the job's log file contents as a list of lines.
-            tool: is the EDA tool used to run the job.
 
         Returns:
             a tuple of (runtime, units).
 
+        Raises:
+            RuntimeError: exception if the search pattern is not found.
+
         """
         pattern = r"^CPU [tT]ime:\s*(\d+\.?\d*?)\s*(seconds|minutes|hours).*$"
         for line in reversed(log_text):
@@ -92,7 +94,7 @@ def get_simulated_time(log_text: Sequence[str]) -> tuple[float, str]:
             log_text: is the job's log file contents as a list of lines.
 
         Returns:
-            the simulated, units as a tuple.
+            a tuple of (simulated time, units).
 
         Raises:
             RuntimeError: exception if the search pattern is not found.

src/dvsim/sim/tool/xcelium.py

@@ -93,11 +93,13 @@ def get_job_runtime(log_text: Sequence[str]) -> tuple[float, str]:
 
         Args:
             log_text: is the job's log file contents as a list of lines.
-            tool: is the EDA tool used to run the job.
 
         Returns:
             a tuple of (runtime, units).
 
+        Raises:
+            RuntimeError: exception if the search pattern is not found.
+
         """
         pattern = r"^TOOL:\s*xrun.*: Exiting on .*\(total:\s*(\d+):(\d+):(\d+)\)\s*$"
         for line in reversed(log_text):
@@ -121,7 +123,7 @@ def get_simulated_time(log_text: Sequence[str]) -> tuple[float, str]:
             log_text: is the job's log file contents as a list of lines.
 
         Returns:
-            the simulated, units as a tuple.
+            a tuple of (simulated time, units).
 
         Raises:
             RuntimeError: exception if the search pattern is not found.