From 4e770509dbbb30fb8a69a64d3fe45430a6f417a4 Mon Sep 17 00:00:00 2001 From: Florian Agbuya Date: Mon, 4 Sep 2023 16:06:33 +0800 Subject: [PATCH] almazny: fix doc formatting --- artiq/coredevice/almazny.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/artiq/coredevice/almazny.py b/artiq/coredevice/almazny.py index a78992b28..f7dacc94a 100644 --- a/artiq/coredevice/almazny.py +++ b/artiq/coredevice/almazny.py @@ -21,7 +21,7 @@ class AlmaznyLegacy: This applies to Almazny hardware v1.1 and earlier. Use :class:`artiq.coredevice.almazny.AlmaznyChannel` for Almazny v1.2 and later. - :param host_mirny - Mirny device Almazny is connected to + :param host_mirny: Mirny device Almazny is connected to """ def __init__(self, dmgr, host_mirny): @@ -61,8 +61,9 @@ class AlmaznyLegacy: def set_att(self, channel, att, rf_switch=True): """ Sets attenuators on chosen shift register (channel). + :param channel - index of the register [0-3] - :param att_mu - attenuation setting in dBm [0-31.5] + :param att - attenuation setting in dBm [0-31.5] :param rf_switch - rf switch (bool) """ self.set_att_mu(channel, self.att_to_mu(att), rf_switch) @@ -71,6 +72,7 @@ class AlmaznyLegacy: def set_att_mu(self, channel, att_mu, rf_switch=True): """ Sets attenuators on chosen shift register (channel). + :param channel - index of the register [0-3] :param att_mu - attenuation setting in machine units [0-63] :param rf_switch - rf switch (bool) @@ -83,6 +85,7 @@ class AlmaznyLegacy: def output_toggle(self, oe): """ Toggles output on all shift registers on or off. + :param oe - toggle output enable (bool) """ self.output_enable = oe @@ -141,6 +144,7 @@ class AlmaznyChannel: """ Convert an attenuation in dB, RF switch state and LED state to machine units. + :param att: attenuator setting in dB (0-31.5) :param enable: RF switch state (bool) :param led: LED state (bool) @@ -162,6 +166,7 @@ class AlmaznyChannel: def set_mu(self, mu): """ Set channel state (machine units). + :param mu: channel state in machine units. """ self.mirny_cpld.write_ext( @@ -171,6 +176,7 @@ class AlmaznyChannel: def set(self, att, enable, led=False): """ Set attenuation, RF switch, and LED state (SI units). + :param att: attenuator setting in dB (0-31.5) :param enable: RF switch state (bool) :param led: LED state (bool)