Skip to content

Commit 2e734b2

Browse files
committed
Minor update to bcm docs
1 parent 7c93ca5 commit 2e734b2

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

doc/bcm.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _bcm:
2+
13
Broadcast Manager
24
=================
35

doc/bus.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ class, for example::
1111
vector_bus = can.Bus(interface='vector', ...)
1212

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

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

@@ -35,8 +34,9 @@ API
3534
Transmitting
3635
''''''''''''
3736

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

4141

4242
Receiving

0 commit comments

Comments
 (0)