Skip to content

Commit b7d576d

Browse files
committed
docs/library/pyb.CAN: Clean up documentation of data constants.
1 parent a25e6c6 commit b7d576d

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/library/pyb.CAN.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -259,23 +259,23 @@ Constants
259259
---------
260260

261261
.. data:: CAN.NORMAL
262-
.. data:: CAN.LOOPBACK
263-
.. data:: CAN.SILENT
264-
.. data:: CAN.SILENT_LOOPBACK
262+
CAN.LOOPBACK
263+
CAN.SILENT
264+
CAN.SILENT_LOOPBACK
265265

266-
the mode of the CAN bus
266+
The mode of the CAN bus used in :meth:`~CAN.init()`.
267267

268268
.. data:: CAN.STOPPED
269269
CAN.ERROR_ACTIVE
270270
CAN.ERROR_WARNING
271271
CAN.ERROR_PASSIVE
272272
CAN.BUS_OFF
273273

274-
Possible states of the CAN controller.
274+
Possible states of the CAN controller returned from :meth:`~CAN.state()`.
275275

276276
.. data:: CAN.LIST16
277-
.. data:: CAN.MASK16
278-
.. data:: CAN.LIST32
279-
.. data:: CAN.MASK32
277+
CAN.MASK16
278+
CAN.LIST32
279+
CAN.MASK32
280280

281-
the operation mode of a filter
281+
The operation mode of a filter used in :meth:`~CAN.setfilter()`.

0 commit comments

Comments
 (0)