forked from M-Labs/artiq
1
0
Fork 0

language: Clarify now_mu() docstring [nfc]

This commit is contained in:
David Nadlinger 2018-10-26 12:46:08 +01:00 committed by Sébastien Bourdeauducq
parent e7d3f36b91
commit f02ceee626
1 changed files with 6 additions and 1 deletions

View File

@ -199,7 +199,12 @@ def delay_mu(duration):
def now_mu():
"""Retrieves the current RTIO time, in machine units."""
"""Retrieve the current RTIO timeline cursor, in machine units.
Note the conceptual difference between this and the current value of the
hardware RTIO counter; see e.g.
:meth:`artiq.coredevice.core.Core.get_rtio_counter_mu` for the latter.
"""
return _time_manager.get_time_mu()