Merge pull request #1 from jposada202020/improving_docs

improving_docs

Author: evaherrada

adafruit_dash_display.py

@@ -52,37 +52,37 @@ def __init__(
 
     @property
     def key(self):
-        """ Getter for feed key """
+        """ Getter for feed key. Will give the value of the feed key"""
         return self._key
 
     @key.setter
     def key(self, value):
-        """ Setter for feed key """
+        """ Setter for feed key. Sets a new value for the feed key property _key"""
         self._key = value
 
     @property
     def text(self):
-        """ Getter for text ready to be formatted """
+        """ Getter for text ready to be formatted. Will give the feed text"""
         return self._text
 
     @text.setter
     def text(self, value):
-        """ Setter for text ready to be formatted """
+        """ Setter for text ready to be formatted. Allows to change the feed text"""
         self._text = value
 
     @property
     def callback(self):
-        """ Getter for callback function """
+        """ Getter for callback function. Returns the feed callback"""
         return self._callback
 
     @callback.setter
     def callback(self, value):
-        """ Setter for callback function """
+        """ Setter for callback function. Changes the feed callback """
         self._callback = value
 
     @property
     def color(self):
-        """ Getter for text color callback function """
+        """ Getter for text color callback function. Will return the color for the feed"""
         return self._color
 
     @color.setter

docs/api.rst

@@ -5,4 +5,5 @@
 .. use this format as the module name: "adafruit_foo.foo"
 
 .. automodule:: adafruit_dash_display
-    :members:
+   :members:
+   :member-order: bysource

docs/examples.rst

@@ -7,6 +7,11 @@ Ensure your device works with this simple test.
     :caption: examples/dash_display_simpletest.py
     :linenos:
 
+Advanced example
+----------------
+
+This illustrates more features of the library
+
 .. literalinclude:: ../examples/dash_display_advancedtest.py
     :caption: examples/dash_display_advancedtest.py
     :linenos:

docs/index.rst

@@ -24,6 +24,8 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
+    Adafruit IO IOT Hub with the Adafruit FunHouse <https://learn.adafruit.com/adafruit-io-hub-with-the-adafruit-funhouse>
+
 .. toctree::
     :caption: Related Products