diff options
| author | Damien George <damien.p.george@gmail.com> | 2018-03-16 18:29:43 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-03-16 18:29:43 +1100 |
| commit | b7d576d69a8ef104d4a5538fd09ed97806a15369 (patch) | |
| tree | 92e1005ab653098a9dc1abd7db7adabdbaceda2a | |
| parent | a25e6c6b650acf3af742920c1d3a024054c986cb (diff) | |
docs/library/pyb.CAN: Clean up documentation of data constants.
| -rw-r--r-- | docs/library/pyb.CAN.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst index e1ce90d60..5fe4c2ecf 100644 --- a/docs/library/pyb.CAN.rst +++ b/docs/library/pyb.CAN.rst @@ -259,11 +259,11 @@ Constants --------- .. data:: CAN.NORMAL -.. data:: CAN.LOOPBACK -.. data:: CAN.SILENT -.. data:: CAN.SILENT_LOOPBACK + CAN.LOOPBACK + CAN.SILENT + CAN.SILENT_LOOPBACK - the mode of the CAN bus + The mode of the CAN bus used in :meth:`~CAN.init()`. .. data:: CAN.STOPPED CAN.ERROR_ACTIVE @@ -271,11 +271,11 @@ Constants CAN.ERROR_PASSIVE CAN.BUS_OFF - Possible states of the CAN controller. + Possible states of the CAN controller returned from :meth:`~CAN.state()`. .. data:: CAN.LIST16 -.. data:: CAN.MASK16 -.. data:: CAN.LIST32 -.. data:: CAN.MASK32 + CAN.MASK16 + CAN.LIST32 + CAN.MASK32 - the operation mode of a filter + The operation mode of a filter used in :meth:`~CAN.setfilter()`. |