From 444a8adb73138ddaa222fd7b20880861353a7a50 Mon Sep 17 00:00:00 2001 From: Kevin Matocha Date: Sat, 5 Sep 2020 11:35:28 -0500 Subject: [PATCH] Correct documentation errors related to mutability --- adafruit_display_text/bitmap_label.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/adafruit_display_text/bitmap_label.py b/adafruit_display_text/bitmap_label.py index bf348fe..26332b7 100755 --- a/adafruit_display_text/bitmap_label.py +++ b/adafruit_display_text/bitmap_label.py @@ -50,13 +50,12 @@ class Label(displayio.Group): """A label displaying a string of text that is stored in a bitmap. Note: This ``bitmap_label.py`` library utilizes a bitmap to display the text. This method is memory-conserving relative to ``label.py``. - For the bitmap_label library, the font, text, and line_spacing must be set at - instancing and are immutable. The ``max_glyphs`` parameter is ignored and is present + The ``max_glyphs`` parameter is ignored and is present only for direct compatability with label.py. - For use cases where text changes are required after the initial instancing, please - use the `label.py` library. - For further reduction in memory usage, set save_text to False (text string will not - be stored). + + For further reduction in memory usage, set ``save_text=False`` (text string will not + be stored and ``line_spacing`` and ``font`` are immutable with ``save_text`` + set to ``False``). The origin point set by ``x`` and ``y`` properties will be the left edge of the bounding box, and in the center of a M