From d6fcc0529f74dd6561025d5223829ba26da5136e Mon Sep 17 00:00:00 2001 From: David Nadlinger Date: Fri, 26 Oct 2018 11:56:33 +0100 Subject: [PATCH] coredevice: Imperative mood in docstrings [nfc] This follows Python conventions (PEP257) and unifies the style with other comments. --- artiq/coredevice/core.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/artiq/coredevice/core.py b/artiq/coredevice/core.py index 0caf31edb..60abcf96b 100644 --- a/artiq/coredevice/core.py +++ b/artiq/coredevice/core.py @@ -134,7 +134,7 @@ class Core: @portable def seconds_to_mu(self, seconds): - """Converts seconds to the corresponding number of machine units + """Convert seconds to the corresponding number of machine units (RTIO cycles). :param seconds: time (in seconds) to convert. @@ -143,7 +143,7 @@ class Core: @portable def mu_to_seconds(self, mu): - """Converts machine units (RTIO cycles) to seconds. + """Convert machine units (RTIO cycles) to seconds. :param mu: cycle count to convert. """ @@ -166,7 +166,7 @@ class Core: @kernel def get_drtio_link_status(self, linkno): - """Returns whether the specified DRTIO link is up. + """Return whether the specified DRTIO link is up. This is particularly useful in startup kernels to delay startup until certain DRTIO links are up."""