Skip to content

Commit 9563ef0

Browse files
committed
type links in the docstrings for bitmap label.
1 parent 934c380 commit 9563ef0

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

adafruit_display_text/bitmap_label.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939

4040
class Label(LabelBase):
4141
"""A label displaying a string of text that is stored in a bitmap.
42-
Note: This ``bitmap_label.py`` library utilizes a bitmap to display the text.
43-
This method is memory-conserving relative to ``label.py``.
42+
Note: This ``bitmap_label.py`` library utilizes a :py:class:`~displayio.Bitmap`
43+
to display the text. This method is memory-conserving relative to ``label.py``.
4444
4545
For further reduction in memory usage, set ``save_text=False`` (text string will not
4646
be stored and ``line_spacing`` and ``font`` are immutable with ``save_text``
@@ -537,5 +537,9 @@ def _get_valid_label_directions(self) -> Tuple[str, ...]:
537537

538538
@property
539539
def bitmap(self):
540-
"""The Bitmap object that the text and background are drawn into."""
540+
"""
541+
The Bitmap object that the text and background are drawn into.
542+
543+
:rtype: displayio.Bitmap
544+
"""
541545
return self._bitmap

0 commit comments

Comments
 (0)