Skip to content

Commit df94e2f

Browse files
authored
Merge pull request adafruit#92 from kmatch98/bitmap_mutable
Correct documentation errors related to mutability
2 parents a836740 + 444a8ad commit df94e2f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

adafruit_display_text/bitmap_label.py

+5-6
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,12 @@ class Label(displayio.Group):
5050
"""A label displaying a string of text that is stored in a bitmap.
5151
Note: This ``bitmap_label.py`` library utilizes a bitmap to display the text.
5252
This method is memory-conserving relative to ``label.py``.
53-
For the bitmap_label library, the font, text, and line_spacing must be set at
54-
instancing and are immutable. The ``max_glyphs`` parameter is ignored and is present
53+
The ``max_glyphs`` parameter is ignored and is present
5554
only for direct compatability with label.py.
56-
For use cases where text changes are required after the initial instancing, please
57-
use the `label.py` library.
58-
For further reduction in memory usage, set save_text to False (text string will not
59-
be stored).
55+
56+
For further reduction in memory usage, set ``save_text=False`` (text string will not
57+
be stored and ``line_spacing`` and ``font`` are immutable with ``save_text``
58+
set to ``False``).
6059
6160
The origin point set by ``x`` and ``y``
6261
properties will be the left edge of the bounding box, and in the center of a M

0 commit comments

Comments
 (0)