Skip to content

Commit a914afc

Browse files
committed
Fix broken docs
1 parent 9e8863a commit a914afc

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

doc/interfaces/ixxat.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ The can_id/mask must be specified according to IXXAT behaviour, that is
6868
bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
6969
VCI documentation, section "Message filters" for more info.
7070

71-
.. hint:: Module uses ``can.ixxat`` logger and at DEBUG level logs every frame
72-
sent or received. It may be too verbose for your purposes.
71+
.. hint::
72+
73+
Module uses ``can.ixxat`` logger and at DEBUG level logs every frame
74+
sent or received. It may be too verbose for your purposes.
7375

doc/interfaces/socketcan_native.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ bindSocket
4141

4242

4343
captureMessage
44-
~~~~~~~~~~~~~
44+
~~~~~~~~~~~~~~
4545

4646
.. autofunction:: can.interfaces.socketcan.socketcan_native.captureMessage

doc/listeners.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ SqliteWriter
5959

6060

6161
ASC (.asc Logging format)
62-
---------
62+
-------------------------
63+
6364
ASCWriter logs CAN data to an ASCII log file compatible with other CAN tools such as
6465
Vector CANalyzer/CANoe and other.
6566
Since no official specification exists for the format, it has been reverse-
@@ -78,19 +79,20 @@ as further references can-utils can be used:
7879
:members:
7980

8081
Log (.log can-utils Logging format)
81-
---------
82-
canutilsLogWriter logs CAN data to an ASCII log file compatible with `can-utils <https://github.com/linux-can/can-utils>`
82+
-----------------------------------
83+
84+
CanutilsLogWriter logs CAN data to an ASCII log file compatible with `can-utils <https://github.com/linux-can/can-utils>`
8385
As specification following references can-utils can be used:
8486
`asc2log <https://github.com/linux-can/can-utils/blob/master/asc2log.c>`_,
8587
`log2asc <https://github.com/linux-can/can-utils/blob/master/log2asc.c>`_.
8688

8789

88-
.. autoclass:: can.canutilsLogWriter
90+
.. autoclass:: can.io.CanutilsLogWriter
8991
:members:
9092

91-
canutilsLogReader reads CAN data from ASCII log files .log
93+
CanutilsLogReader reads CAN data from ASCII log files .log
9294

93-
.. autoclass:: can.canutilsLogReader
95+
.. autoclass:: can.io.CanutilsLogReader
9496
:members:
9597

9698

0 commit comments

Comments
 (0)