Document overloads of display.update()

pygame-community · Dec 15, 2024 · 629cc2f · 629cc2f
1 parent 803a9da
commit 629cc2f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/buildconfig/stubs/pygame/display.pyi b/buildconfig/stubs/pygame/display.pyi
@@ -47,8 +47,10 @@ def set_mode(
 def get_surface() -> Optional[Surface]: ...
 def flip() -> None: ...
 @overload
+def update() -> None: ...
+@overload
 def update(
-    rectangle: Optional[Union[RectLike, Iterable[Optional[RectLike]]]] = None, /
+    rectangle: Optional[Union[RectLike, Iterable[Optional[RectLike]]]], /
 ) -> None: ...
 @overload
 def update(x: float, y: float, w: float, h: float, /) -> None: ...

diff --git a/docs/reST/ref/display.rst b/docs/reST/ref/display.rst
@@ -273,7 +273,10 @@ required).
 .. function:: update
 
    | :sl:`Update all, or a portion, of the display. For non-OpenGL displays.`
-   | :sg:`update(rectangle=None, /) -> None`
+   | :sg:`update() -> None`
+   | :sg:`update(rectangle, /) -> None`
+   | :sg:`update(x, y, w, h, /) -> None`
+   | :sg:`update((x, y), (w, h), /) -> None`
    | :sg:`update(rectangle_iterable, /) -> None`
 
    For non OpenGL display Surfaces, this function is very similar to