Skip to content

Commit 116cb3b

Browse files
Merge pull request #1596 from IntelPython/sycl-timer-use-note
Use Note in SyclTimer docstring
2 parents c37c1da + 335b9f0 commit 116cb3b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

dpctl/_sycl_timer.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ class SyclTimer:
6969
# retrieve elapsed times in milliseconds
7070
wall_dt, device_dt = timer.dt
7171
72-
Remark:
72+
Note:
7373
The timer submits barriers to the queue at the entrance and the
7474
exit of the context and uses profiling information from events
7575
associated with these submissions to perform the timing. Thus
7676
:class:`dpctl.SyclTimer` requires the queue with "enable_profiling"
77-
property. In order to be able to collect the profiling information
78-
the property `dt` ensures that both submitted barriers complete
79-
their execution and thus effectively synchronizing the queue.
77+
property. In order to be able to collect the profiling information,
78+
the `dt` property ensures that both submitted barriers complete their
79+
execution and thus effectively synchronizes the queue.
8080
8181
Args:
8282
host_timer (callable): A callable such that host_timer() returns current

0 commit comments

Comments
 (0)