📝 Add additional information regarding datetime to docstrings

Author: kzscisoft

simvue/models.py

@@ -43,8 +43,10 @@ def simvue_timestamp(
 
     Parameters
     ----------
-    date_time: datetime.datetime, optional
-        if provided, the datetime object to convert, else use current date and time
+    date_time: datetime.datetime | str, optional
+        if provided, the datetime object to convert,
+        else use current date and time
+        if a string assume to be local time.
 
     Returns
     -------

simvue/run.py

@@ -1270,8 +1270,9 @@ def log_event(
         ----------
         message : str
             event message to log
-        timestamp : datetime, optional
+        timestamp : datetime.datetime | str, optional
             manually specify the time stamp for this log, by default None
+            if a string is provided, local time
 
         Returns
         -------
@@ -1494,8 +1495,9 @@ def log_metrics(
             manually specify the step index for this log, by default None
         time : int, optional
             manually specify the time for this log, by default None
-        timestamp : str, optional
-            manually specify the timestamp for this log, by default None
+        timestamp : datetime.datetime | str, optional
+            manually specify the time stamp for this log, by default None
+            if a string is provided, local time
 
         Returns
         -------