Skip to content

Commit 246f78e

Browse files
committed
Docs Corrections
1 parent 4eb377c commit 246f78e

File tree

1 file changed

+2
-32
lines changed

1 file changed

+2
-32
lines changed

adafruit_display_text/__init__.py

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ def wrap_text_to_pixels(
3232
:return: A list of the lines resulting from wrapping the
3333
input text at ``max_width`` pixels size
3434
:rtype: List[str]
35+
3536
"""
3637
# pylint: disable=too-many-locals, too-many-branches
3738
if font is None:
@@ -159,68 +160,37 @@ class LabelBase(Group):
159160
160161
Subclasses should implement ``_set_text``, ``_set_font``, and ``_set_line_spacing`` to
161162
have the correct behavior for that type of label.
162-
163-
Anchor points are represented in the corners of the following graph
164-
165-
(0.0,0.0)┌──────────────────────────────────────────────────────────────┐ (1.0,0.0)
166-
│ @@ | │
167-
│ @@ Ascent │
168-
│ @@ | │
169-
│------------------------------------------@@+-----|-----------│
170-
│ %@ @% @@@@@@@@% %@@@@@@@@ | │
171-
│ %@ @% @@% %@ @% %@@ | │
172-
│ %@% @@ @% %@ @@ | │ Bounding BOX
173-
│ %@% @@ @$ $@ @@ | │
174-
│ %@ @% @@$ @ @% $@@ | │
175-
│ %@ @% @@@@@@@% %@@@@@@@ | │
176-
│-------------------@@+----------------------------------------│ Baseline
177-
│ @@ | │
178-
│ @@ Descent │
179-
│ @@___| │
180-
(0.0,1.0)╰──────────────────────────────────────────────────────────────┘(1.0,1.0)
181-
182163
:param Font font: A font class that has ``get_bounding_box`` and ``get_glyph``.
183164
Must include a capital M for measuring character size.
184165
:param str text: Text to display
185166
:param int max_glyphs: Unnecessary parameter (provided only for direct compability
186167
with :py:func:`~adafruit_display_text.label.Label`)
187-
188168
:param int color: Color of all text in RGB hex
189169
:param int background_color: Color of the background, use `None` for transparent
190-
191170
:param float line_spacing: Line spacing of text to display
192-
193171
:param bool background_tight: Set `True` only if you want background box to tightly
194172
surround text. When set to 'True' Padding parameters will be ignored.
195-
196173
:param int padding_top: Additional pixels added to background bounding box at top
197174
:param int padding_bottom: Additional pixels added to background bounding box at bottom
198175
:param int padding_left: Additional pixels added to background bounding box at left
199176
:param int padding_right: Additional pixels added to background bounding box at right
200-
201177
:param (float,float) anchor_point: Point that anchored_position moves relative to.
202178
Tuple with decimal percentage of width and height.
203179
(E.g. (0,0) is top left, (1.0, 0.5): is middle right.)
204180
:param (int,int) anchored_position: Position relative to the anchor_point. Tuple
205181
containing x,y pixel coordinates.
206-
207182
:param int scale: Integer value of the pixel scaling
208-
209183
:param bool save_text: Set True to save the text string as a constant in the
210184
label structure. Set False to reduce memory use.
211-
212185
:param bool base_alignment: when True allows to align text label to the baseline.
213186
This is helpful when two or more labels need to be aligned to the same baseline
214-
215187
:param (int,str) tab_replacement: tuple with tab character replace information. When
216188
(4, " ") will indicate a tab replacement of 4 spaces, defaults to 4 spaces by
217189
tab character
218-
219190
:param str label_direction: string defining the label text orientation. There are 5
220191
configurations possibles ``LTR``-Left-To-Right ``RTL``-Right-To-Left
221192
``TTB``-Top-To-Bottom ``UPR``-Upwards ``DWR``-Downwards and ``UPD``-Upside-Down
222-
(bitmap_label only). It defaults to ``LTR``
223-
"""
193+
(bitmap_label only). It defaults to ``LTR``"""
224194

225195
# pylint: disable=unused-argument, too-many-instance-attributes, too-many-locals, too-many-arguments
226196
def __init__(

0 commit comments

Comments
 (0)