A few more doc updates. Move some internal stuff into own page.

hardbyte · hardbyte · Jan 7, 2019 · Jan 7, 2019 · Jan 7, 2019 · Jan 7, 2019
commit e0391f2adb4c8339f463b3cd254f250683e3aa45
diff --git a/can/interface.py b/can/interface.py
@@ -145,7 +145,7 @@ def detect_available_configs(interfaces=None):
         - `None` to search in all known interfaces.
     :rtype: list[dict]
     :return: an iterable of dicts, each suitable for usage in
-             the constructor of :class:`can.interface.Bus`.
+             the constructor of :class:`can.BusABC`.
     """
 
     # Figure out where to search

diff --git a/can/io/generic.py b/can/io/generic.py
@@ -26,7 +26,7 @@ def __init__(self, file, mode='rt'):
         :param file: a path-like object to open a file, a file-like object
                      to be used as a file or `None` to not use a file at all
         :param str mode: the mode that should be used to open the file, see
-                         :func:`builtin.open`, ignored if *file* is `None`
+                         :func:`open`, ignored if *file* is `None`
         """
         if file is None or (hasattr(file, 'read') and hasattr(file, 'write')):
             # file is None or some file-like object

diff --git a/doc/api.rst b/doc/api.rst
@@ -17,19 +17,16 @@ A form of CAN interface is also required.
    listeners
    asyncio
    bcm
+   internal-api
 
 
 Utilities
 ---------
 
-.. automodule:: can.util
-    :members:
 
 .. automethod:: can.detect_available_configs
 
 
-
-
 .. _notifier:
 
 Notifier

diff --git a/doc/interfaces/canalystii.rst b/doc/interfaces/canalystii.rst
@@ -1,7 +1,8 @@
 CANalyst-II
 ===========
 
-CANalyst-II(+) is a USB to CAN Analyzer. The controlcan library is originally developed by `ZLG ZHIYUAN Electronics`_.
+CANalyst-II(+) is a USB to CAN Analyzer. The controlcan library is originally developed by
+`ZLG ZHIYUAN Electronics`_.
 
 
 Bus

diff --git a/doc/internal-api.rst b/doc/internal-api.rst
@@ -0,0 +1,25 @@
+Internal API
+============
+
+Here we document the odds and ends that are more helpful for creating your own interfaces
+or listeners but generally shouldn't be required to interact with python-can.
+
+
+
+
+IO Utilities
+------------
+
+
+.. automodule:: can.io.generic
+    :members:
+
+
+
+Other Util
+----------
+
+
+.. automodule:: can.util
+    :members:
+
diff --git a/doc/message.rst b/doc/message.rst
@@ -113,7 +113,7 @@ Message
 
         .. note::
 
-            The :meth:`Message.__init__` argument ``extended_id`` has been deprecated in favor of
+            The initializer argument and attribute ``extended_id`` has been deprecated in favor of
             ``is_extended_id``, but will continue to work for the ``3.x`` release series.
 
 
@@ -129,7 +129,7 @@ Message
 
     .. attribute:: is_remote_frame
 
-        :type: boolean
+        :type: bool
 
         This boolean attribute indicates if the message is a remote frame or a data frame, and
         modifies the bit in the CAN message's flags field indicating this.