Skip to content

Commit

Permalink
Included Usage description for classes/LED.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
speratus committed Jul 26, 2019
1 parent 0a89cd2 commit 586d53e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/classes/LED.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,17 @@ Represents the possible LEDs in an individual pixel. This class needs only
be used in methods of the :class:`Pixel` class.

.. autoclass:: LED
:members:
:members:

Usage
-----
This enumeration is intended to be used in a very limited set of circumstances. Its main purpose is to serve as a
convenience class for certain operations inside the :class:`Pixel` class. Given the limited scope of its usefulness,
it may be removed in the future.

**Example:** ::
...
#Code for obtaining a Pixel class
pixel.set_led(LED.GREEN, 100)
...

0 comments on commit 586d53e

Please sign in to comment.