Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs fix for time, weird generation in c api #3316

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Docs fix for time, weird generation in c api #3316

merged 2 commits into from
Jan 29, 2025
+4 −5

Conversation

Starbuck5
Copy link
Member

This PR has two independent (but small) changes.

  • Replace incorrect info in time module doc. Noticed this with Zoldalma's docs->stubs PR, when I typed in pygame.time the first thing I saw was that there is a TIMER_RESOLUTION I had never heard of. This was removed in SDL2 and we just set it zero for compat. Not helping anyone by recommending its usage here.
  • Fix function arg doc generation. Noticed warning about this when generating the docs for the first change.

@Starbuck5 Starbuck5 added docs time pygame.time labels Jan 28, 2025
@Starbuck5 Starbuck5 requested a review from a team as a code owner January 28, 2025 08:56
damusss
damusss requested changes Jan 28, 2025
View reviewed changes
buildconfig/stubs/pygame/time.pyi Outdated Show resolved Hide resolved
@Starbuck5
Replace incorrect info in time module doc
de551bc
@Starbuck5
Fix function arg doc generation
db58feb 
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.
damusss
damusss approved these changes Jan 29, 2025
View reviewed changes
Copy link
Member

@damusss damusss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, LGTM, thanks :)

ankith26
ankith26 approved these changes Jan 29, 2025
View reviewed changes
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! ✨

@ankith26 ankith26 added this to the 2.5.3 milestone Jan 29, 2025
@ankith26 ankith26 merged commit 9fae1cf into pygame-community:main Jan 29, 2025
21 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damusss damusss damusss approved these changes

@ankith26 ankith26 ankith26 approved these changes

Assignees
No one assigned
Labels
docs time pygame.time
Projects
None yet
Milestone
2.5.3
Development

Successfully merging this pull request may close these issues.
3 participants
@Starbuck5 @ankith26 @damusss