srenblad
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

Docs: fix build warnings (#1234) 

* ad9910: finish CONT_RECIRCULATE -> CONT_RAMPUP

Found while building docs. Forgot to refactor strings.

Signed-off-by: Drew Risinger <drewrisinger@users.noreply.github.com>

* spi2: reformat update_xfer_duration_mu docstring

update_xfer_duration_mu docstring threw warning while building docs,
didn't use consistent indent in warning.

Signed-off-by: Drew Risinger <drewrisinger@users.noreply.github.com>
This commit is contained in:
Drew 2019-01-08 22:39:23 -05:00 committed by Sébastien Bourdeauducq
parent 4fb434674d
commit 40370c4d45
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
artiq/coredevice/ad9910.py
View File

@ -441,7 +441,7 @@ class AD9910:
:param mode: Profile RAM mode (:const:`RAM_MODE_DIRECTSWITCH`, :param mode: Profile RAM mode (:const:`RAM_MODE_DIRECTSWITCH`,
:const:`RAM_MODE_RAMPUP`, :const:`RAM_MODE_BIDIR_RAMP`, :const:`RAM_MODE_RAMPUP`, :const:`RAM_MODE_BIDIR_RAMP`,
:const:`RAM_MODE_CONT_BIDIR_RAMP`, or :const:`RAM_MODE_CONT_BIDIR_RAMP`, or
:const:`RAM_MODE_CONT_RECIRCULATE`, default: :const:`RAM_MODE_CONT_RAMPUP`, default:
:const:`RAM_MODE_RAMPUP`) :const:`RAM_MODE_RAMPUP`)
""" """
hi = (step << 8) | (end >> 2) hi = (step << 8) | (end >> 2)

8
artiq/coredevice/spi2.py
View File

@ -187,10 +187,10 @@ class SPIMaster:
:meth:`__init__`. :meth:`__init__`.
.. warning:: If this method is called while recording a DMA .. warning:: If this method is called while recording a DMA
sequence, the playback of the sequence will not update the sequence, the playback of the sequence will not update the
driver state. driver state.
When required, update the driver state manually (by calling When required, update the driver state manually (by calling
this method) after playing back a DMA sequence. this method) after playing back a DMA sequence.
:param div: SPI clock divider (see: :meth:`set_config_mu`) :param div: SPI clock divider (see: :meth:`set_config_mu`)
:param length: SPI transfer length (see: :meth:`set_config_mu`) :param length: SPI transfer length (see: :meth:`set_config_mu`)