forked from M-Labs/artiq
coredevice/suservo: Slightly reword get_adc[_mu]() docstring for clarity
This hopefully suggests a bit better that the value is the last one fetched by the servo (i.e. needs the servo active to update), rather than somehow requesting a new sample to be taken.
This commit is contained in:
parent
4446ebf9ca
commit
99e490f9ff
|
@ -191,7 +191,7 @@ class SUServo:
|
||||||
|
|
||||||
@kernel
|
@kernel
|
||||||
def get_adc_mu(self, adc):
|
def get_adc_mu(self, adc):
|
||||||
"""Get an ADC reading (IIR filter input X0) in machine units.
|
"""Get the latest ADC reading (IIR filter input X0) in machine units.
|
||||||
|
|
||||||
This method does not advance the timeline but consumes all slack.
|
This method does not advance the timeline but consumes all slack.
|
||||||
|
|
||||||
|
@ -225,7 +225,7 @@ class SUServo:
|
||||||
|
|
||||||
@kernel
|
@kernel
|
||||||
def get_adc(self, channel):
|
def get_adc(self, channel):
|
||||||
"""Get an ADC reading (IIR filter input X0).
|
"""Get the latest ADC reading (IIR filter input X0).
|
||||||
|
|
||||||
This method does not advance the timeline but consumes all slack.
|
This method does not advance the timeline but consumes all slack.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue