suservo: document gain state

close #1030
2018-05-31 16:36:53 +00:00 · 2018-05-31 16:36:53 +00:00 · e136709cac
commit e136709cac
parent 5dbdc5650c
1 changed files with 4 additions and 0 deletions
--- a/artiq/coredevice/suservo.py
+++ b/artiq/coredevice/suservo.py
@ -199,6 +199,10 @@ class SUServo:

        This method does not advance the timeline but consumes all slack.

+        The PGIA gain setting must be known prior to using this method, either
+        by setting the gain (:meth:`set_pgia_mu`) or by supplying it
+        (:attr:`gains` or via the constructor/device database).
+
        :param adc: ADC channel number (0-7)
        :return: ADC voltage
        """