Skip to content

Commit 6da6a49

Browse files
committed
Update docs.
1 parent ca1f2ae commit 6da6a49

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

adafruit_pybadger/pybadger_base.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,10 @@ def badge_line(self, text=" ", color=(0, 0, 0), scale=1, font=terminalio.FONT,
258258
is equivalent to the height of two lines of text, etc. Defaults
259259
to ``0``.
260260
261+
The following example is designed to work on CLUE. To adapt for PyBadge or PyGamer, change
262+
the ``scale`` and ``padding_above`` values to fit the text to the display. Examples for
263+
CLUE, and PyBadge and PyGamer are included in the examples folder in the library repo.
264+
261265
.. code-block:: python
262266
263267
from adafruit_pybadger import pybadger
@@ -316,7 +320,8 @@ def badge_line(self, text=" ", color=(0, 0, 0), scale=1, font=terminalio.FONT,
316320
self._y_position += height * scale + 4
317321

318322
def show(self):
319-
"""Call ``pybadger.show()`` to display the custom badge elements."""
323+
"""Call ``pybadger.show()`` to display the custom badge elements. If ``show()`` is not
324+
called, the custom badge elements will not be displayed."""
320325
if not self._created_background:
321326
self._create_badge_background()
322327

0 commit comments

Comments
 (0)