pre-commit and sphinx

Author: FoamyGuy

README.rst

@@ -45,10 +45,6 @@ Adafruit 24LC32 I2C EEPROM Breakout
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-24lc32/>`_.

adafruit_24lc32.py

@@ -190,9 +190,9 @@ class EEPROM_I2C(EEPROM):
     :param: ~busio.I2C i2c_bus: The I2C bus the EEPROM is connected to.
     :param: int address: I2C address of EEPROM. Default address is ``0x50``.
     :param: bool write_protect: Turns on/off initial write protection.
-                                Default is ``False``.
+    Default is ``False``.
     :param: wp_pin: (Optional) Physical pin connected to the ``WP`` breakout pin.
-                    Must be a ``digitalio.DigitalInOut`` object.
+    Must be a ``digitalio.DigitalInOut`` object.
     """
 
     # pylint: disable=too-many-arguments
@@ -245,6 +245,7 @@ def _write(self, start_address, data, wraparound=False):
                 i2c.write(buffer)
 
                 time.sleep(0.005)
+
     # pylint: disable=no-member
     @EEPROM.write_protected.setter
     def write_protected(self, value):

docs/conf.py

@@ -29,8 +29,15 @@
 
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),"BusDevice": ("https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", None),
-    "Register": ("https://circuitpython.readthedocs.io/projects/register/en/latest/", None),
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
+    "Register": (
+        "https://circuitpython.readthedocs.io/projects/register/en/latest/",
+        None,
+    ),
     "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
 }
 

docs/index.rst

@@ -24,8 +24,6 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
 
 .. toctree::
     :caption: Related Products

examples/24lc32_simpletest.py

@@ -12,8 +12,8 @@
 eeprom[0] = 4
 print(eeprom[0])
 
-#eeprom[0:3] = [9, 3, 8, 1]
-#print(eeprom[0:3])
+# eeprom[0:3] = [9, 3, 8, 1]
+# print(eeprom[0:3])
 
 while True:
     pass

setup.py

@@ -59,7 +59,6 @@
     ],
     # What does your project relate to?
     keywords="adafruit blinka circuitpython micropython 24lc32 EEPROM memory nvm",
-
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,