jepler/Adafruit_CircuitPython_Display_Text
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docstring fix for new sphinx

Browse source
This commit is contained in:
foamyguy 2021-01-07 18:40:36 -06:00
parent 28b3879f5b
commit bcd7c653ec
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
adafruit_display_text/bitmap_label.py
View file

@ -66,24 +66,24 @@ class Label(displayio.Group):
Must include a capital M for measuring character size. Must include a capital M for measuring character size.
:param str text: Text to display :param str text: Text to display
:param int max_glyphs: Unnecessary parameter (provided only for direct compability :param int max_glyphs: Unnecessary parameter (provided only for direct compability
with label.py) with label.py)
:param int color: Color of all text in RGB hex :param int color: Color of all text in RGB hex
:param int background_color: Color of the background, use `None` for transparent :param int background_color: Color of the background, use `None` for transparent
:param double line_spacing: Line spacing of text to display :param double line_spacing: Line spacing of text to display
:param boolean background_tight: Set `True` only if you want background box to tightly :param boolean background_tight: Set `True` only if you want background box to tightly
surround text surround text
:param int padding_top: Additional pixels added to background bounding box at top :param int padding_top: Additional pixels added to background bounding box at top
:param int padding_bottom: Additional pixels added to background bounding box at bottom :param int padding_bottom: Additional pixels added to background bounding box at bottom
:param int padding_left: Additional pixels added to background bounding box at left :param int padding_left: Additional pixels added to background bounding box at left
:param int padding_right: Additional pixels added to background bounding box at right :param int padding_right: Additional pixels added to background bounding box at right
:param (double,double) anchor_point: Point that anchored_position moves relative to. :param (double,double) anchor_point: Point that anchored_position moves relative to.
Tuple with decimal percentage of width and height. Tuple with decimal percentage of width and height.
(E.g. (0,0) is top left, (1.0, 0.5): is middle right.) (E.g. (0,0) is top left, (1.0, 0.5): is middle right.)
:param (int,int) anchored_position: Position relative to the anchor_point. Tuple :param (int,int) anchored_position: Position relative to the anchor_point. Tuple
containing x,y pixel coordinates. containing x,y pixel coordinates.
:param int scale: Integer value of the pixel scaling :param int scale: Integer value of the pixel scaling
:param bool save_text: Set True to save the text string as a constant in the :param bool save_text: Set True to save the text string as a constant in the
label structure. Set False to reduce memory use. label structure. Set False to reduce memory use.
""" """
# pylint: disable=unused-argument, too-many-instance-attributes, too-many-locals, too-many-arguments # pylint: disable=unused-argument, too-many-instance-attributes, too-many-locals, too-many-arguments