Skip to content

Commit 6bdc0a0

Browse files
committed
Adapt documentation to match other functions
1 parent 148cbb5 commit 6bdc0a0

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

buildconfig/stubs/pygame/draw.pyi

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -572,8 +572,10 @@ def aalines(
572572
def flood_fill(
573573
surface: Surface, color: Union[ColorLike, Surface], start_pos: Point
574574
) -> Rect:
575-
"""Replace the color of a cluster of connected same-color pixels, beginning
576-
from the starting poosition, with a repeating pattern or solid single color
575+
"""Fill an enclosed, same color area, on a surface.
576+
577+
Replace the color of a cluster of connected same-color pixels, beginning
578+
from the starting position, with a repeating pattern or solid single color.
577579
578580
:param Surface surface: surface to draw on
579581
:param color: color, or surface pattern, to draw with. The alpha value is optional if using a

src_c/doc/draw_doc.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
#define DOC_DRAW_LINES "lines(surface, color, closed, points, width=1) -> Rect\nDraw multiple contiguous straight line segments."
1111
#define DOC_DRAW_AALINE "aaline(surface, color, start_pos, end_pos, width=1) -> Rect\nDraw a straight antialiased line."
1212
#define DOC_DRAW_AALINES "aalines(surface, color, closed, points) -> Rect\nDraw multiple contiguous straight antialiased line segments."
13-
#define DOC_DRAW_FLOODFILL "flood_fill(surface, color, start_pos) -> Rect\nReplace the color of a cluster of connected same-color pixels, beginning"
13+
#define DOC_DRAW_FLOODFILL "flood_fill(surface, color, start_pos) -> Rect\nFill an enclosed, same color area, on a surface."

0 commit comments

Comments
 (0)