Merge pull request #31 from makermelissa/main

Add documentation of DotStar attribute
adafruit · Jan 18, 2022 · f71be29 · f71be29
2 parents 264371b + 69e3548
commit f71be29
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -22,10 +22,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
-        python-version: 3.7
+        python-version: 3.8
     - name: Versions
       run: |
         python3 --version

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,10 +24,10 @@ jobs:
         awk -F '\/' '{ print tolower($2) }' |
         tr '_' '-'
         )
-    - name: Set up Python 3.6
+    - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
-        python-version: 3.6
+        python-version: 3.8
     - name: Versions
       run: |
         python3 --version

diff --git a/adafruit_funhouse/peripherals.py b/adafruit_funhouse/peripherals.py
@@ -46,7 +46,13 @@
 
 
 class Peripherals:
-    """Peripherals Helper Class for the FunHouse Library"""
+    """Peripherals Helper Class for the FunHouse Library
+
+
+    Attributes:
+        dotstars (DotStar): The DotStars on the FunHouse board.
+            See https://circuitpython.readthedocs.io/projects/dotstar/en/latest/api.html
+    """
 
     # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements
     def __init__(self) -> None: