From 0fa6f4ed76f8bdc1dfc39f5253e4949b110b3788 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 4 May 2021 22:14:06 -0400 Subject: [PATCH 1/2] adding_usage_template --- docs/design_guide.rst | 49 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 04a2cc874f..cc6288ccd9 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -251,15 +251,17 @@ After the license comment:: **Hardware:** - * Adafruit `Device Description + * `Adafruit Device Description `_ (Product ID: ) **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://circuitpython.org/downloads + * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register @@ -525,6 +527,51 @@ SPI Example spi.readinto(self.buf) return self.buf[0] + + +Class example template +-------------------------------------------------------------------------------- +When documenting classes, you could use the following template to illustrate the basic class functioning. +it is closely related with the simpletest, however this will display the information in the readthedocs +documentation. +The advantage of using this, is users will be familiar with this as it is used across libraries + +This is an example for a AHT20 temperature sensor. You could locate this after the class parameter +definitions. + + +.. code-block:: python + + """ + + **Quickstart: Importing and using the AHT10/AHT20 temperature sensor** + + Here is an example of using the :class:`AHTx0` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + import adafruit_ahtx0 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + aht = adafruit_ahtx0.AHTx0(i2c) + + Now you have access to the temperature and humidity using + the :attr:`temperature` and :attr:`relative_humidity` attributes + + .. code-block:: python + + temperature = aht.temperature + relative_humidity = aht.relative_humidity + + """ + + Use composition -------------------------------------------------------------------------------- From 0f60a3b997b26b5d0a67d547247867d0b63bb2f0 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Wed, 5 May 2021 12:18:26 -0400 Subject: [PATCH 2/2] Better_phrasing --- docs/design_guide.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index cc6288ccd9..e91060f776 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -529,15 +529,14 @@ SPI Example -Class example template +Class documentation example template -------------------------------------------------------------------------------- -When documenting classes, you could use the following template to illustrate the basic class functioning. -it is closely related with the simpletest, however this will display the information in the readthedocs +When documenting classes, you should use the following template to illustrate basic usage. +It is similar with the simpletest example, however this will display the information in the Read The Docs documentation. -The advantage of using this, is users will be familiar with this as it is used across libraries +The advantage of using this template is it makes the documentation consistent across the libraries. -This is an example for a AHT20 temperature sensor. You could locate this after the class parameter -definitions. +This is an example for a AHT20 temperature sensor. Include the following after the class parameter: .. code-block:: python