Skip to content

Commit 72239a2

Browse files
authored
Merge pull request #3170 from Starbuck5/window-public-docs
Publicize window docs
2 parents c5a419b + 30d50e4 commit 72239a2

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/reST/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,6 @@ turn them to stable API in the future ^^.
6262
:doc:`ref/geometry`
6363
Pygame module for the Circle, Line, and Polygon objects.
6464

65-
:doc:`ref/window`
66-
Pygame object that handles a window.
67-
6865
:doc:`ref/sdl2_controller`
6966
Pygame module to work with controllers.
7067

@@ -244,6 +241,9 @@ Reference
244241
:doc:`ref/typing`
245242
Provide common typehints
246243

244+
:doc:`ref/window`
245+
Pygame object that handles a window.
246+
247247
:doc:`pygame C API <c_api>`
248248
The C api shared amongst pygame extension modules.
249249

docs/reST/ref/window.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
| :sl:`pygame object that represents a window`
1111
| :sg:`Window(title='pygame window', size=(640, 480), position=None, fullscreen=False, fullscreen_desktop=False, **kwargs) -> Window`
1212
13-
The Window class (formerly known as _sdl2.video.Window), is an experimental
14-
feature of pygame-ce. This class allows for programs to drive multiple
15-
Windows on-screen at once, something not possible with the
16-
:func:`pygame.display.set_mode` API. Not everything possible with
13+
The Window class (formerly known as _sdl2.video.Window), is a newly
14+
published feature of pygame-ce 2.5.2. This class allows for programs
15+
to drive multiple Windows on-screen at once, something not possible with
16+
the :func:`pygame.display.set_mode` API. Not everything possible with
1717
:mod:`pygame.display` is possible yet in the Window API, but the new
1818
window class will continue to be developed, and we're excited to share
1919
the new functionality this class offers.

docs/reST/themes/classic/elements.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ <h5>pygame-ce documentation</h5>
4141
{%- set basic = ['Color', 'display', 'draw', 'event', 'font', 'image', 'key', 'locals', 'mixer', 'mouse', 'music', 'pygame', 'Rect', 'Surface', 'time'] %}
4242
{%- set experimental = ['sdl2_video', 'controller', 'geometry', 'Window'] %}
4343
{%- set advanced = ['BufferProxy', 'freetype', 'gfxdraw', 'midi', 'PixelArray', 'pixelcopy', 'sndarray', 'surfarray', 'cursors', 'joystick', 'mask', 'math', 'sprite', 'transform'] %}
44-
{%- set hidden = ['sdl2_video', 'geometry', 'Window'] %}
44+
{%- set hidden = ['sdl2_video', 'geometry'] %}
4545
{%- if pyg_sections %}
4646
<p class="bottom"><b>Most useful stuff</b>:
4747
{% set sep = joiner(" | \n") %}

0 commit comments

Comments
 (0)