Merge pull request #544 from tekktrik/doc/update-readme

Typing Library Documentation Touchups

diff --git a/README.rst b/README.rst
index 8f3aa290927d82c1ad7bb809e84730f2e92c40c8..5e9c020b8301a04ebb53dbcbc2e2dedba4ac8c6b 100755 (executable)
--- a/README.rst
+++ b/README.rst
@@ -20,10 +20,12 @@ Introduction
 This repository contains a selection of packages emulating the CircuitPython API
 for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:
 
+* **_typing** - (Legacy) subset of types for C-level protocols
 * **analogio** - analog input/output pins, using pin identities from board+microcontroller packages
 * **bitbangio** - software-driven interfaces for I2C, SPI
 * **board** - breakout-specific pin identities
 * **busio** - hardware-driven interfaces for I2C, SPI, UART
+* **circuitpython_typing** - Subset of types for C-level protocols
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
 * **keypad** - support for scanning keys and key matrices
 * **microcontroller** - chip-specific pin identities

diff --git a/src/_typing.py b/src/_typing.py
index 3c1671bf9d6816f07532c0b47ce6bc00084faf5e..0e371c41423d62037b24f6bd499ebacdbc2e9847 100644 (file)
--- a/src/_typing.py
+++ b/src/_typing.py
@@ -23,9 +23,9 @@
 `_typing` - Define (legacy) subset of types for C-level protocols
 =================================================================
 
-See `CircuitPython:circuitpython_typing` in CircuitPython for more details.
-
 * Author(s): Alec Delaney
+
+See `CircuitPython:circuitpython_typing` in CircuitPython for more details.
 """
 
 from circuitpython_typing import *  # pylint: disable=wildcard-import,unused-wildcard-import

diff --git a/src/circuitpython_typing.py b/src/circuitpython_typing.py
index 3df3587f7e88fe286bfe75eca52ebbf42b3fe0c5..3ab01c3f5c4a1434bd715b3b6386d162e5eb1b30 100644 (file)
--- a/src/circuitpython_typing.py
+++ b/src/circuitpython_typing.py
@@ -34,17 +34,19 @@ from numpy import ndarray
 
 ReadableBuffer = Union[bytes, bytearray, memoryview, array, ndarray]
 """Classes that implement the readable buffer protocol
-  - `bytes`
-  - `bytearray`
-  - `memoryview`
-  - `array.array`
-  - ``numpy.ndarray``
+
+  * `bytes`
+  * `bytearray`
+  * `memoryview`
+  * `array.array`
+  * ``numpy.ndarray``
 """
 
 WriteableBuffer = Union[bytearray, memoryview, array, ndarray]
 """Classes that implement the writeable buffer protocol
-  - `bytearray`
-  - `memoryview`
-  - `array.array`
-  - ``numpy.ndarray``
+
+  * `bytearray`
+  * `memoryview`
+  * `array.array`
+  * ``numpy.ndarray``
 """