Skip to content

Commit 6224c65

Browse files
committed
Update request_display_config docstring
1 parent 3cd3c6e commit 6224c65

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

adafruit_fruitjam/peripherals.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,11 @@ def request_display_config(width=None, height=None, color_depth=None):
6363
6464
This function will set the initialized display to ``supervisor.runtime.display``
6565
66-
:param width: The width of the display in pixels.
67-
:param height: The height of the display in pixels.
66+
:param width: The width of the display in pixels. Leave unspecified to default
67+
to the ``CIRCUITPY_DISPLAY_WIDTH`` environmental variable if provided. Otherwise,
68+
a ``ValueError`` exception will be thrown.
69+
:param height: The height of the display in pixels. Leave unspecified to default
70+
to the appropriate height for the provided width.
6871
:param color_depth: The color depth of the display in bits.
6972
Valid values are 1, 2, 4, 8, 16, 32. Larger resolutions must use
7073
smaller color_depths due to RAM limitations. Default color_depth for

0 commit comments

Comments
 (0)