Filtering docs.

Author: hardbyte

can/bus.py

@@ -33,6 +33,8 @@ def __init__(self, channel=None, can_filters=None, **config):
 
             >>> [{"can_id": 0x11, "can_mask": 0x21}]
 
+            A filter matches, when ``<received_can_id> & can_mask == can_id & can_mask``
+
         :param dict config:
             Any backend dependent configurations are passed in this dictionary
         """
@@ -80,6 +82,10 @@ def flush_tx_buffer(self):
         pass
 
     def shutdown(self):
+        """
+        Called to carry out any interface specific cleanup required
+        in shutting down a bus.
+        """
         self.flush_tx_buffer()
 
     __metaclass__ = abc.ABCMeta

doc/api.rst

@@ -1,10 +1,10 @@
 Library API
 ===========
 
-The main objects are the :class:`~can.Bus` and the :class:`~can.Message`.
+The main objects are the :class:`~can.BusABC` and the :class:`~can.Message`.
 A form of CAN interface is also required.
 
-.. warning::
+.. hint::
 
     Check the backend specific documentation for any implementation specific details.
 

doc/bus.rst

@@ -4,15 +4,23 @@ Bus
 ---
 
 The :class:`~can.Bus` class, as the name suggests, provides an abstraction of a CAN bus.
-The bus provides a wrapper around a physical or virtual CAN Bus. Where the interface
-supports it, message filtering is carried out for each bus.
+The bus provides a wrapper around a physical or virtual CAN Bus.
+
+
+Filtering
+'''''''''
+
+Message filtering can be set up for each bus. Where the interface supports it, this is carried
+out in the hardware or kernel layer - not in Python.
+
 
 
 API
 ''''
 
 .. autoclass:: can.BusABC
     :members:
+    :special-members: __iter__
 
 
 Transmitting