Merge branch 'cdeil-fix-docstrings' into development

Author: einarf

arcade/application.py

@@ -1388,9 +1388,9 @@ def on_mouse_drag(
                 Change in x since the last time this method was called
             dy:
                 Change in y since the last time this method was called
-            buttons:
+            _buttons:
                 Which button is pressed
-            modifiers:
+            _modifiers:
                 Bitwise 'and' of all modifiers (shift, ctrl, num lock)
                 active during this event. See :ref:`keyboard_modifiers`.
         """
@@ -1493,9 +1493,9 @@ def on_key_release(self, _symbol: int, _modifiers: int) -> bool | None:
         * Showing which keys are currently pressed down
 
         Args:
-            symbol:
+            _symbol:
                 Key that was released
-            modifiers:
+            _modifiers:
                 Bitwise 'and' of all modifiers (shift, ctrl, num lock) active
                 during this event. See :ref:`keyboard_modifiers`.
         """

arcade/cache/hit_box.py

@@ -59,10 +59,8 @@ def get(self, name_or_texture: str | Texture) -> Point2List | None:
             points = cache.get("hash|(0, 1, 2, 3)|simple|")
 
         Args:
-            keys:
+            name_or_texture:
                 The texture or cache name to get the hit box for
-            hit_box_algorithm:
-                The hit box algorithm used
         """
         from arcade import Texture
 
@@ -85,7 +83,7 @@ def put(self, name_or_texture: str | Texture, points: Point2List) -> None:
             cache.put("my_custom_points", points)
 
         Args:
-            keys:
+            name_or_texture:
                 The texture or cache name to store the hit box for
             points:
                 The hit box points

arcade/camera/camera_2d.py

@@ -343,13 +343,14 @@ def match_window(
         Should be called when the window is resized.
 
         Args:
-            and_projection: Flag whether to also equalize the projection to the viewport.
+            viewport: Flag whether to equalise the viewport to the value.
+            projection: Flag whether to also equalize the projection to the viewport.
                 On by default
-            and_scissor: Flag whether to also equalize the scissor box to the viewport.
+            scissor: Flag whether to also equalize the scissor box to the viewport.
                 On by default
-            and_position: Flag whether to also center the camera to the viewport.
+            position: Flag whether to also center the camera to the viewport.
                 Off by default
-            aspect_ratio: The ratio between width and height that the viewport should
+            aspect: The ratio between width and height that the viewport should
                 be constrained to. If unset then the viewport just matches the window
                 size. The aspect ratio describes how much larger the width should be
                 compared to the height. i.e. for an aspect ratio of ``4:3`` you should
@@ -383,7 +384,7 @@ def match_target(
             scissor: Flag whether to update the scissor value.
             position: Flag whether to also center the camera to the value.
                 Off by default
-            aspect_ratio: The ratio between width and height that the value should
+            aspect: The ratio between width and height that the value should
                 be constrained to. i.e. for an aspect ratio of ``4:3`` you should
                 input ``4.0/3.0`` or ``1.33333...``. Cannot be equal to zero.
                 If unset then the value will not be updated.
@@ -425,7 +426,7 @@ def update_values(
             scissor: Flag whether to update the scissor value.
             position: Flag whether to also center the camera to the value.
                 Off by default
-            aspect_ratio: The ratio between width and height that the value should
+            aspect: The ratio between width and height that the value should
                 be constrained to. i.e. for an aspect ratio of ``4:3`` you should
                 input ``4.0/3.0`` or ``1.33333...``. Cannot be equal to zero.
                 If unset then the value will not be updated.

arcade/camera/data_types.py

@@ -450,8 +450,6 @@ def unproject(self, screen_coordinate: Point) -> Vec3:
         Args:
             screen_coordinate: A 2D position in pixels should generally be inside
                 the range of the active viewport.
-            depth: The depth of the query. This can be though of how far along the forward vector
-                   the final coord will be.
         Returns:
             A 3D vector in world space.
         """

arcade/camera/default.py

@@ -24,7 +24,7 @@ class ViewportProjector:
 
     Args:
         viewport: The viewport to project to.
-        window: The window to bind the camera to. Defaults to the currently active window.
+        context: The window context to bind the camera to. Defaults to the currently active window.
     """
 
     def __init__(
@@ -108,7 +108,7 @@ class DefaultProjector(ViewportProjector):
     no instance where a developer would want to use this class.
 
     Args:
-        window: The window to bind the camera to. Defaults to the currently active window.
+        context: The window context to bind the camera to. Defaults to the currently active window.
     """
 
     def __init__(self, *, context: ArcadeContext | None = None):

arcade/camera/orthographic.py

@@ -181,11 +181,9 @@ def unproject(self, screen_coordinate: Point) -> Vec3:
         Args:
             screen_coordinate: A 2D position in pixels from the bottom left of the screen.
                                This should ALWAYS be in the range of 0.0 - screen size.
-            depth: The depth of the query
         Returns:
             A 3D vector in world space.
         """
-
         _projection = generate_orthographic_matrix(self._projection, self._view.zoom)
         _view = generate_view_matrix(self._view)
         return unproject_orthographic(screen_coordinate, self.viewport.lbwh_int, _view, _projection)

arcade/draw/rect.py

@@ -207,9 +207,9 @@ def draw_lbwh_rectangle_outline(
     Draw a rectangle extending from bottom left to top right
 
     Args:
-        bottom_left_x:
+        left:
             The x coordinate of the left edge of the rectangle.
-        bottom_left_y:
+        bottom:
             The y coordinate of the bottom of the rectangle.
         width:
             The width of the rectangle.

arcade/future/light/lights.py

@@ -87,7 +87,8 @@ class LightLayer(RenderTargetTexture):
     The size of a layer should ideally be of the same size and the screen.
 
     Args:
-        size: Width and height of light layer
+        width: Width of light layer
+        height: Height of light layer
     """
 
     def __init__(self, width: int, height: int):

arcade/future/video/video_player.py

@@ -37,11 +37,16 @@ def __init__(self, path: str | Path, loop: bool = False):
 
     def draw(self, left: int = 0, bottom: int = 0, size: tuple[int, int] | None = None) -> None:
         """
-        Call this in `on_draw`.
+        Draw the current video frame.
 
         Args:
-            size: Pass None as one of the elements if you want to use the
-            dimension(width, height) attribute.
+            left:
+                Window position from the left.
+            bottom:
+                Window position from the bottom.
+            size:
+                The size of the video rectangle.
+                If `None`, the video will be drawn in its original size.
         """
         if size and len(size) == 2:
             self._width = size[0] or self.width

arcade/gl/framebuffer.py

@@ -347,8 +347,6 @@ def clear(
                 A 3 or 4 component tuple containing the color in normalized form
             depth:
                 Value to clear the depth buffer (unused)
-            normalized:
-                If the color values are normalized or not
             viewport:
                 The viewport range to clear
         """