Skip to content

Commit 0d2b274

Browse files
committed
single lines for params
1 parent 5f7eb2a commit 0d2b274

File tree

1 file changed

+14
-24
lines changed

1 file changed

+14
-24
lines changed

adafruit_pyportal.py

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -97,41 +97,31 @@ def json(self):
9797

9898

9999
class PyPortal:
100+
# pylint: disable=line-too-long
100101
"""Class representing the Adafruit PyPortal.
101102
102103
:param url: The URL of your data source. Defaults to ``None``.
103-
:param json_path: The list of json traversal to get data out of.
104-
Can be list of lists for multiple data points. Defaults to ``None`` to not use json.
105-
:param regexp_path: The list of regexp strings to get data out (use a single regexp group).
106-
Can be list of regexps for multiple data points. Defaults to ``None`` to not use regexp.
104+
:param json_path: The list of json traversal to get data out of. Can be list of lists for multiple data points. Defaults to ``None`` to not use json.
105+
:param regexp_path: The list of regexp strings to get data out (use a single regexp group). Can be list of regexps for multiple data points. Defaults to ``None`` to not use regexp.
107106
:param default_bg: The path to your default background image file. Defaults to ``None``.
108-
:param status_neopixel: The pin for the status NeoPixel. Use ``board.NEOPIXEL`` for the
109-
on-board NeoPixel. Defaults to ``None``, no status LED
107+
:param status_neopixel: The pin for the status NeoPixel. Use ``board.NEOPIXEL`` for the on-board NeoPixel. Defaults to ``None``, no status LED
110108
:param str text_font: The path to your font file for your data text display.
111-
:param text_position: The position of your extracted text on the display in an (x, y) tuple.
112-
Can be a list of tuples for when there's a list of json_paths, for example
113-
:param text_color: The color of the text, in 0xRRGGBB format. Can be a list of colors for
114-
when there's multiple texts. Defaults to ``None``.
115-
:param text_wrap: Whether or not to wrap text (for long text data chunks).
116-
Defaults to ``False``, no wrapping.
109+
:param text_position: The position of your extracted text on the display in an (x, y) tuple. Can be a list of tuples for when there's a list of json_paths, for example
110+
:param text_color: The color of the text, in 0xRRGGBB format. Can be a list of colors for when there's multiple texts. Defaults to ``None``.
111+
:param text_wrap: Whether or not to wrap text (for long text data chunks). Defaults to ``False``, no wrapping.
117112
:param text_maxlen: The max length of the text for text wrapping. Defaults to 0.
118-
:param image_json_path: The JSON traversal path for a background image to display.
119-
Defaults to ``None``.
120-
:param image_resize: What size to resize the image we got from the json_path,
121-
make this a tuple of the width and height you want. Defaults to ``None``.
122-
:param image_position: The position of the image on the display as an (x, y) tuple.
123-
Defaults to ``None``.
124-
:param success_callback: A function we'll call if you like, when we fetch data successfully.
125-
Defaults to ``None``.
126-
:param str caption_text: The text of your caption, a fixed text not changed by the data we get.
127-
Defaults to ``None``.
113+
:param image_json_path: The JSON traversal path for a background image to display. Defaults to ``None``.
114+
:param image_resize: What size to resize the image we got from the json_path, make this a tuple of the width and height you want. Defaults to ``None``.
115+
:param image_position: The position of the image on the display as an (x, y) tuple. Defaults to ``None``.
116+
:param success_callback: A function we'll call if you like, when we fetch data successfully. Defaults to ``None``.
117+
:param str caption_text: The text of your caption, a fixed text not changed by the data we get. Defaults to ``None``.
128118
:param str caption_font: The path to the font file for your caption. Defaults to ``None``.
129-
:param caption_position: The position of your caption on the display as an (x, y) tuple.
130-
Defaults to ``None``.
119+
:param caption_position: The position of your caption on the display as an (x, y) tuple. Defaults to ``None``.
131120
:param caption_color: The color of your caption. Must be a hex value, e.g. ``0x808000``.
132121
:param debug: Turn on debug print outs. Defaults to False.
133122
134123
"""
124+
# pylint: enable=line-too-long
135125
# pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements
136126
def __init__(self, *, url=None, json_path=None, regexp_path=None,
137127
default_bg=None, status_neopixel=None,

0 commit comments

Comments
 (0)