From 5f445f6b929c3985cbc3bf80ac029048b6c50b0a Mon Sep 17 00:00:00 2001 From: mwojcik Date: Mon, 16 Oct 2023 11:21:04 +0800 Subject: [PATCH] ad53xx: fix `load()` references in documentation --- artiq/coredevice/ad53xx.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/artiq/coredevice/ad53xx.py b/artiq/coredevice/ad53xx.py index 9a2b8eb2e..76bad29bb 100644 --- a/artiq/coredevice/ad53xx.py +++ b/artiq/coredevice/ad53xx.py @@ -233,7 +233,7 @@ class AD53xx: def write_gain_mu(self, channel, gain=0xffff): """Program the gain register for a DAC channel. - The DAC output is not updated until LDAC is pulsed (see :meth load:). + The DAC output is not updated until LDAC is pulsed (see :meth:`load`). This method advances the timeline by the duration of one SPI transfer. :param gain: 16-bit gain register value (default: 0xffff) @@ -245,7 +245,7 @@ class AD53xx: def write_offset_mu(self, channel, offset=0x8000): """Program the offset register for a DAC channel. - The DAC output is not updated until LDAC is pulsed (see :meth load:). + The DAC output is not updated until LDAC is pulsed (see :meth:`load`). This method advances the timeline by the duration of one SPI transfer. :param offset: 16-bit offset register value (default: 0x8000) @@ -258,7 +258,7 @@ class AD53xx: """Program the DAC offset voltage for a channel. An offset of +V can be used to trim out a DAC offset error of -V. - The DAC output is not updated until LDAC is pulsed (see :meth load:). + The DAC output is not updated until LDAC is pulsed (see :meth:`load`). This method advances the timeline by the duration of one SPI transfer. :param voltage: the offset voltage @@ -270,7 +270,7 @@ class AD53xx: def write_dac_mu(self, channel, value): """Program the DAC input register for a channel. - The DAC output is not updated until LDAC is pulsed (see :meth load:). + The DAC output is not updated until LDAC is pulsed (see :meth:`load`). This method advances the timeline by the duration of one SPI transfer. """ self.bus.write( @@ -280,7 +280,7 @@ class AD53xx: def write_dac(self, channel, voltage): """Program the DAC output voltage for a channel. - The DAC output is not updated until LDAC is pulsed (see :meth load:). + The DAC output is not updated until LDAC is pulsed (see :meth:`load`). This method advances the timeline by the duration of one SPI transfer. """ self.write_dac_mu(channel, voltage_to_mu(voltage, self.offset_dacs, @@ -313,7 +313,7 @@ class AD53xx: If no LDAC device was defined, the LDAC pulse is skipped. - See :meth load:. + See :meth:`load`. :param values: list of DAC values to program :param channels: list of DAC channels to program. If not specified, @@ -355,7 +355,7 @@ class AD53xx: """ Two-point calibration of a DAC channel. Programs the offset and gain register to trim out DAC errors. Does not - take effect until LDAC is pulsed (see :meth load:). + take effect until LDAC is pulsed (see :meth:`load`). Calibration consists of measuring the DAC output voltage for a channel with the DAC set to zero-scale (0x0000) and full-scale (0xffff).