Skip to content

Commit 5296415

Browse files
committed
chore: remove references to ClockResolution in docstrings
1 parent 5fd76e3 commit 5296415

File tree

4 files changed

+7
-29
lines changed

4 files changed

+7
-29
lines changed

packets/log_entry/log_entry.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -285,10 +285,7 @@ def timestamp(self) -> int:
285285
"""
286286
Represents the timestamp of this LogEntry object.
287287
This property returns the creation time of this LogEntry
288-
object. If specified, the SmartInspect Python library tries
289-
to use high-resolution timestamps. Please see the
290-
SmartInspect.set_resolution() method for more information
291-
on timestamps.
288+
object.
292289
"""
293290
return self.__timestamp
294291

@@ -297,10 +294,7 @@ def timestamp(self, timestamp: int) -> None:
297294
"""
298295
Represents the timestamp of this LogEntry object.
299296
This property returns the creation time of this LogEntry
300-
object. If specified, the SmartInspect Python library tries
301-
to use high-resolution timestamps. Please see the
302-
SmartInspect.set_resolution() method for more information
303-
on timestamps.
297+
object.
304298
"""
305299
self.__timestamp = timestamp
306300

packets/process_flow/process_flow.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,7 @@ def timestamp(self) -> int:
141141
"""
142142
Represents the timestamp of this ProcessFlow object.
143143
This property returns the creation time of this ProcessFlow
144-
object. If specified, the SmartInspect Python library tries to
145-
use high-resolution timestamps. Please see the
146-
SmartInspect.set_resolution() method for more information
147-
on timestamps.
144+
object.
148145
"""
149146
return self.__timestamp
150147

@@ -153,10 +150,7 @@ def timestamp(self, timestamp: int) -> None:
153150
"""
154151
Sets the timestamp of this ProcessFlow object.
155152
This property returns the creation time of this ProcessFlow
156-
object. If specified, the SmartInspect Python library tries to
157-
use high-resolution timestamps. Please see the
158-
SmartInspect.set_resolution() method for more information
159-
on timestamps.
153+
object.
160154
"""
161155
if isinstance(timestamp, int):
162156
self.__timestamp = timestamp

packets/watch.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,7 @@ def timestamp(self):
133133
"""
134134
Represents the timestamp of this Watch object.
135135
This property returns the creation time of this Watch
136-
object. If specified, the SmartInspect Python library tries
137-
to use high-resolution timestamps. Please see the
138-
SmartInspect.set_resolution() method for more information
139-
on timestamps.
136+
object.
140137
"""
141138
return self.__timestamp
142139

@@ -145,10 +142,7 @@ def timestamp(self, timestamp: int) -> None:
145142
"""
146143
Sets the timestamp of this Watch object.
147144
This property returns the creation time of this Watch
148-
object. If specified, the SmartInspect Python library tries
149-
to use high-resolution timestamps. Please see the
150-
SmartInspect.set_resolution() method for more information
151-
on timestamps.
145+
object.
152146
"""
153147
if not isinstance(timestamp, int):
154148
raise TypeError("timestamp must be an integer")

smartinspect.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,7 @@ def __init__(self, appname: str):
9696
@staticmethod
9797
def now() -> int:
9898
"""
99-
Returns the current date and time, optionally with a high resolution.
100-
If the resolution property specifies using a high resolution for timestamps,
101-
this method tries to return a timestamp with a microsecond resolution.
102-
If high-resolution support is not available, this method simply returns the local date and time
103-
with the help of the time.time() function and the default time zone.
99+
Returns the current date and time.
104100
:return: The current local date and time in microseconds since January 1, 1970
105101
"""
106102
return Clock.now()

0 commit comments

Comments
 (0)