Skip to content

Public docs for Window #2607

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.

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

Merged
merged 1 commit into from
Dec 20, 2023

Conversation

Starbuck5
Copy link
Member

For #2603

This moves the docs for Window from sdl2_video.rst to a new window.rst. I've declined to categorize it, so the new module docs shows up in the "other" category on the module index at the top of the documentation.

I also added the following blurb to the Window class description:

The Window class (formerly known as _sdl2.video.Window), is a newly published feature of pygame-ce 2.4.0. This class allows for programs to drive multiple Windows on-screen at once, something not possible with the pygame.display.set_mode() API. Not everything possible with pygame.display is possible yet in the Window API, but the new window class will continue to be developed, and we're excited to share the new functionality this class offers.

@Starbuck5 Starbuck5 added docs video pygame.video window pygame.Window labels Dec 16, 2023
@Starbuck5 Starbuck5 requested a review from a team as a code owner December 16, 2023 23:20
@Starbuck5
Copy link
Member Author

I'm not sure why the linux circle ci is failing, this is a docs PR, the failure must be unrelated.

Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@Starbuck5 Starbuck5 added this to the 2.4.0 milestone Dec 19, 2023
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.

Generated the docs locally, and while Window does show up in the top bar in the base index.html, it does not show up when focused on the docs for any other submodule

@Starbuck5
Copy link
Member Author

Try running a full regen.

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 for the PR 😎

@Starbuck5 Starbuck5 merged commit a0acfb7 into pygame-community:main Dec 20, 2023
@Starbuck5 Starbuck5 deleted the document-window-publicly branch December 20, 2023 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs video pygame.video window pygame.Window
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants