Skip to content

Commit 8bfe627

Browse files
committed
Fix parameters that can take None
1 parent ccf69f5 commit 8bfe627

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

adafruit_display_shapes/circle.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ class Circle(RoundRect):
3939
:param int x0: The x-position of the center.
4040
:param int y0: The y-position of the center.
4141
:param int r: The radius of the circle.
42-
:param int fill: (Optional) The color to fill the circle. Can be a hex value for a color or
42+
:param int|None fill: The color to fill the circle. Can be a hex value for a color or
4343
``None`` for transparent.
44-
:param int outline: (Optional) The outline of the circle. Can be a hex value for a color or
44+
:param int|None outline: The outline of the circle. Can be a hex value for a color or
4545
``None`` for no outline.
4646
:param int stroke: Used for the outline. Will not change the radius.
4747

adafruit_display_shapes/polygon.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Polygon(displayio.TileGrid):
3737
"""A polygon.
3838
3939
:param list points: A list of (x, y) tuples of the points
40-
:param int outline: (Optional) The outline of the polygon. Can be a hex value for a color or
40+
:param int|None outline: The outline of the polygon. Can be a hex value for a color or
4141
``None`` for no outline.
4242
"""
4343

adafruit_display_shapes/rect.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ class Rect(displayio.TileGrid):
3939
:param int y: The y-position of the top left corner.
4040
:param int width: The width of the rectangle.
4141
:param int height: The height of the rectangle.
42-
:param int fill: (Optional) The color to fill the rectangle. Can be a hex value for a color or
42+
:param int|None fill: The color to fill the rectangle. Can be a hex value for a color or
4343
``None`` for transparent.
44-
:param int outline: (Optional) The outline of the rectangle. Can be a hex value for a color or
44+
:param int|None outline: The outline of the rectangle. Can be a hex value for a color or
4545
``None`` for no outline.
4646
:param int stroke: Used for the outline. Will not change the outer bound size set by ``width``
4747
and ``height``.

adafruit_display_shapes/roundrect.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ class RoundRect(displayio.TileGrid):
3131
:param int width: The width of the rounded-corner rectangle.
3232
:param int height: The height of the rounded-corner rectangle.
3333
:param int r: The radius of the rounded corner.
34-
:param int fill: (Optional) The color to fill the rounded-corner rectangle. Can be a hex value
34+
:param int|None fill: The color to fill the rounded-corner rectangle. Can be a hex value
3535
for a color or ``None`` for transparent.
36-
:param int outline: (Optional) The outline of the rounded-corner rectangle. Can be a hex value
36+
:param int|None outline: The outline of the rounded-corner rectangle. Can be a hex value
3737
for a color or ``None`` for no outline.
3838
:param int stroke: Used for the outline. Will not change the outer bound size set by ``width``
3939
and ``height``.

adafruit_display_shapes/sparkline.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ class Sparkline(displayio.Group):
5555
:param int height: Height of the sparkline graph in pixels
5656
:param int max_items: Maximum number of values housed in the sparkline
5757
:param bool dyn_xpitch: (Optional) Dynamically change xpitch (True)
58-
:param int y_min: (Optional) Lower range for the y-axis. Set to None for autorange.
59-
:param int y_max: (Optional) Upper range for the y-axis. Set to None for autorange.
58+
:param int|None y_min: Lower range for the y-axis. Set to None for autorange.
59+
:param int|None y_max: Upper range for the y-axis. Set to None for autorange.
6060
:param int x: X-position on the screen, in pixels
6161
:param int y: Y-position on the screen, in pixels
6262
:param int color: Line color, the default value is 0xFFFFFF (WHITE)

adafruit_display_shapes/triangle.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ class Triangle(Polygon):
4242
:param int y1: The y-position of the second vertex.
4343
:param int x2: The x-position of the third vertex.
4444
:param int y2: The y-position of the third vertex.
45-
:param int fill: (Optional) The color to fill the triangle. Can be a hex value for a color or
45+
:param int|None fill: The color to fill the triangle. Can be a hex value for a color or
4646
``None`` for transparent.
47-
:param int outline: (Optional) The outline of the triangle. Can be a hex value for a color or
47+
:param int|None outline: The outline of the triangle. Can be a hex value for a color or
4848
``None`` for no outline.
4949
"""
5050
# pylint: disable=too-many-locals

0 commit comments

Comments
 (0)