From de551bc2f66ebc2ca208a6fb53f3fdaec19c65c3 Mon Sep 17 00:00:00 2001 From: Starbuck5 <46412508+Starbuck5@users.noreply.github.com> Date: Tue, 28 Jan 2025 00:51:43 -0800 Subject: [PATCH 1/2] Replace incorrect info in time module doc --- buildconfig/stubs/pygame/time.pyi | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/buildconfig/stubs/pygame/time.pyi b/buildconfig/stubs/pygame/time.pyi index 455629a1c4..1b2c9ebc88 100644 --- a/buildconfig/stubs/pygame/time.pyi +++ b/buildconfig/stubs/pygame/time.pyi @@ -1,8 +1,8 @@ """Pygame module for monitoring time. -Times in pygame are represented in milliseconds (1/1000 seconds). Most -platforms have a limited time resolution of around 10 milliseconds. This -resolution, in milliseconds, is given in the ``TIMER_RESOLUTION`` constant. +Provides utilities for monitoring time, delaying time, and maintaining a +constant frame rate. +Times in pygame-ce are represented in milliseconds (1/1000 of a second). """ from typing import Union, final From db58feb707caced7f0a1c0ee32025da55410d87e Mon Sep 17 00:00:00 2001 From: Starbuck5 <46412508+Starbuck5@users.noreply.github.com> Date: Tue, 28 Jan 2025 00:52:41 -0800 Subject: [PATCH 2/2] Fix function arg doc generation The second line of arguments was being seen as a whole new function, rather than part of the first thing. So I moved all arguments to one (long) line. --- docs/reST/c_api/base.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/reST/c_api/base.rst b/docs/reST/c_api/base.rst index 5fbfd9f55d..f53d9813c6 100644 --- a/docs/reST/c_api/base.rst +++ b/docs/reST/c_api/base.rst @@ -178,8 +178,7 @@ C header: src_c/include/pygame.h Argument *screen* may be *NULL*. This functions is called by pygame.display.set_mode(). -.. c:function:: PyObject* pgObject_getRectHelper(PyObject *rect, PyObject *const *args, - Py_ssize_t nargs, PyObject *kwnames, char *type) +.. c:function:: PyObject* pgObject_getRectHelper(PyObject *rect, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames, char *type) Return a rectangle covering the entire object. Rectangle will start at (0, 0) with a width and height the same size as the object. You can pass keyword