Skip to content
Prev Previous commit
Next Next commit
Minor update to bcm docs
  • Loading branch information
hardbyte committed Sep 22, 2018
commit 33798b00d1f8640e9d2e78d587c0d7f885e2de42
2 changes: 2 additions & 0 deletions doc/bcm.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _bcm:

Broadcast Manager
=================

Expand Down
8 changes: 4 additions & 4 deletions doc/bus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ class, for example::
vector_bus = can.Bus(interface='vector', ...)

That bus is then able to handle the interface specific software/hardware interactions
and implements the :class:`~can.BusABC` API. It itself is an instance of ``VectorBus``,
but these specififc buses should not be instantiated directly.
and implements the :class:`~can.BusABC` API.

A thread safe bus wrapper is also available, see `Thread safe bus`_.

Expand All @@ -35,8 +34,9 @@ API
Transmitting
''''''''''''

Writing to the bus is done by calling the :meth:`~can.BusABC.send` method and
passing a :class:`~can.Message` instance.
Writing individual messages to the bus is done by calling the :meth:`~can.BusABC.send` method
and passing a :class:`~can.Message` instance. Periodic sending is controlled by the
:ref:`broadcast manager <bcm>`.


Receiving
Expand Down