adafruit-mirror/Adafruit_CircuitPython_PyBadger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update docs.

Browse source
This commit is contained in:
Kattni Rembor 2020-02-26 14:09:32 -05:00
parent ca1f2aec16
commit 6da6a493ee
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
adafruit_pybadger/pybadger_base.py
View file

@ -258,6 +258,10 @@ class PyBadgerBase:
is equivalent to the height of two lines of text, etc. Defaults
to ``0``.
The following example is designed to work on CLUE. To adapt for PyBadge or PyGamer, change
the ``scale`` and ``padding_above`` values to fit the text to the display. Examples for
CLUE, and PyBadge and PyGamer are included in the examples folder in the library repo.
.. code-block:: python
from adafruit_pybadger import pybadger
@ -316,7 +320,8 @@ class PyBadgerBase:
self._y_position += height * scale + 4
def show(self):
"""Call ``pybadger.show()`` to display the custom badge elements."""
"""Call ``pybadger.show()`` to display the custom badge elements. If ``show()`` is not
called, the custom badge elements will not be displayed."""
if not self._created_background:
self._create_badge_background()