Skip to content

Commit 4f4028b

Browse files
einarfeinarf
authored
Fix primitive drawing docstrings (#2405)
1 parent 9834472 commit 4f4028b

8 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎arcade/draw/arc.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def draw_arc_filled(
3232
height of the arc.
3333
color:
3434
A 3 or 4 length tuple of 0-255 channel values or a
35-
:py:class:`~arcade.types.Color` instance.
35+
:py:class:`.Color` instance.
3636
start_angle:
3737
start angle of the arc in degrees.
3838
end_angle:
@@ -93,7 +93,7 @@ def draw_arc_outline(
9393
height of the arc.
9494
color:
9595
A 3 or 4 length tuple of 0-255 channel values or a
96-
:py:class:`~arcade.types.Color` instance.
96+
:py:class:`.Color` instance.
9797
start_angle:
9898
Start angle of the arc in degrees.
9999
end_angle:

‎arcade/draw/circle.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def draw_circle_filled(
2525
width of the circle.
2626
color:
2727
A 3 or 4 length tuple of 0-255 channel values
28-
or a :py:class:`~arcade.types.Color` instance.
28+
or a :py:class:`.Color` instance.
2929
tilt_angle:
3030
Angle in degrees to tilt the circle. Useful for low segment count circles
3131
num_segments:
@@ -66,7 +66,7 @@ def draw_circle_outline(
6666
width of the circle.
6767
color:
6868
A 3 or 4 length tuple of 0-255 channel values
69-
or a :py:class:`~arcade.types.Color` instance.
69+
or a :py:class:`.Color` instance.
7070
border_width:
7171
Width of the circle outline in pixels.
7272
tilt_angle:
@@ -113,9 +113,9 @@ def draw_ellipse_filled(
113113
height of the ellipse.
114114
color:
115115
A 3 or 4 length tuple of 0-255 channel values
116-
or a :py:class:`~arcade.types.Color` instance.
116+
or a :py:class:`.Color` instance.
117117
color:
118-
Either a :py:class:`~arcade.types.Color` instance
118+
Either a :py:class:`.Color` instance
119119
or an RGBA :py:class:`tuple` of 4 byte values (0 to 255).
120120
tilt_angle:
121121
Angle in degrees to tilt the ellipse (clockwise).
@@ -173,7 +173,7 @@ def draw_ellipse_outline(
173173
height of the ellipse.
174174
color:
175175
A 3 or 4 length tuple of 0-255 channel values
176-
or a :py:class:`~arcade.types.Color` instance.
176+
or a :py:class:`.Color` instance.
177177
border_width:
178178
Width of the circle outline in pixels.
179179
tilt_angle:

‎arcade/draw/helpers.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def _generic_draw_line_strip(
5555
So it is a list of lists.
5656
color:
5757
A color, specified as an RGBA tuple or a
58-
:py:class:`~arcade.types.Color` instance.
58+
:py:class:`.Color` instance.
5959
"""
6060
# Fail if we don't have a window, context, or right GL abstractions
6161
window = get_window()

‎arcade/draw/line.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def draw_line_strip(point_list: Point2List, color: RGBOrA255, line_width: float
1616
List of x, y points that make up this strip
1717
color:
1818
A color, specified as an RGBA tuple or a
19-
:py:class:`~arcade.types.Color` instance.
19+
:py:class:`.Color` instance.
2020
line_width:
2121
Width of the line
2222
"""
@@ -59,7 +59,7 @@ def draw_line(
5959
y position of line ending point.
6060
color:
6161
A color, specified as an RGBA tuple or a
62-
:py:class:`~arcade.types.Color` instance.
62+
:py:class:`.Color` instance.
6363
line_width:
6464
Width of the line in pixels.
6565
"""
@@ -96,7 +96,7 @@ def draw_lines(point_list: Point2List, color: RGBOrA255, line_width: float = 1)
9696
So it is a list of lists.
9797
color:
9898
A color, specified as an RGBA tuple or a
99-
:py:class:`~arcade.types.Color` instance.
99+
:py:class:`.Color` instance.
100100
line_width:
101101
Width of the line in pixels.
102102
"""

‎arcade/draw/parabola.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def draw_parabola_filled(
2525
The height of the parabola
2626
color:
2727
A 3 or 4 length tuple of 0-255 channel values
28-
or a :py:class:`~arcade.types.Color` instance.
28+
or a :py:class:`.Color` instance.
2929
tilt_angle:
3030
The angle of the tilt of the parabola (clockwise)
3131
"""
@@ -60,7 +60,7 @@ def draw_parabola_outline(
6060
The height of the parabola
6161
color:
6262
A 3 or 4 length tuple of 0-255 channel values
63-
or a :py:class:`~arcade.types.Color` instance.
63+
or a :py:class:`.Color` instance.
6464
border_width:
6565
The width of the parabola
6666
tilt_angle:

‎arcade/draw/polygon.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def draw_polygon_outline(point_list: Point2List, color: RGBOrA255, line_width: f
3131
in a list. So it is a list of lists.
3232
color:
3333
The color of the outline as an RGBA :py:class:`tuple` or
34-
:py:class:`~arcade.types.Color` instance.
34+
:py:class:`.Color` instance.
3535
line_width:
3636
Width of the line in pixels.
3737
"""

‎arcade/draw/rect.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ def draw_texture_rect(
3030
3131
Args:
3232
texture:
33-
Identifier of texture returned from load_texture() call
33+
The texture to draw.
3434
rect:
3535
Rectangle to draw the texture on.
3636
color:
37-
Color of the texture. Defaults to white.
37+
Color multiplier for the texture. Defaults to white.
3838
angle:
3939
Rotation of the texture in degrees. Defaults to zero.
4040
blend:
@@ -275,7 +275,7 @@ def draw_lbwh_rectangle_filled(
275275
The height of the rectangle.
276276
color:
277277
The fill color as an RGBA :py:class:`tuple`, RGB
278-
:py:class:`tuple`, :py:class:`~arcade.types.Color` instance
278+
:py:class:`tuple`, :py:class:`.Color` instance
279279
"""
280280
draw_rect_filled(LBWH(left, bottom, width, height), color)
281281

@@ -288,10 +288,10 @@ def draw_rect_outline(
288288
289289
Args:
290290
rect:
291-
The rectangle to draw. a :py:class`~arcade.types.Rect` instance.
291+
The rectangle to draw. a :py:class:`~arcade.Rect` instance.
292292
color:
293-
The fill color as an RGBA :py:class:`tuple`,
294-
RGB :py:class:`tuple`, or :py:class`.Color` instance.
293+
The outline color as an RGBA :py:class:`tuple`,
294+
RGB :py:class:`tuple`, or :py:class:`.Color` instance.
295295
border_width:
296296
width of the lines, in pixels.
297297
tilt_angle:
@@ -373,10 +373,10 @@ def draw_rect_filled(rect: Rect, color: RGBOrA255, tilt_angle: float = 0) -> Non
373373
374374
Args:
375375
rect:
376-
The rectangle to draw. a :py:class`~arcade.types.Rect` instance.
376+
The rectangle to draw. a :py:class:`~arcade.Rect` instance.
377377
color:
378378
The fill color as an RGBA :py:class:`tuple`,
379-
RGB :py:class:`tuple, or :py:class`.Color` instance.
379+
RGB :py:class:`tuple`, or :py:class:`.Color` instance.
380380
tilt_angle:
381381
rotation of the rectangle (clockwise). Defaults to zero.
382382
"""

‎arcade/draw/triangle.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def draw_triangle_filled(
1919
x3: x value of third coordinate.
2020
y3: y value of third coordinate.
2121
color: Color of the triangle as an RGBA :py:class:`tuple` or
22-
:py:class:`~arcade.types.Color` instance.
22+
:py:class:`.Color` instance.
2323
"""
2424
point_list = (
2525
(x1, y1),
@@ -50,7 +50,7 @@ def draw_triangle_outline(
5050
x3: x value of third coordinate.
5151
y3: y value of third coordinate.
5252
color: RGBOrA255 of triangle as an RGBA
53-
:py:class:`tuple` or :py:class`~arcade.types.Color` instance.
53+
:py:class:`tuple` or :py:class:`.Color` instance.
5454
border_width: Width of the border in pixels. Defaults to 1.
5555
"""
5656
point_list = (

0 commit comments

Comments
 (0)