Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ported the docs from sdl2_video to
pygame._render
, using the autoapi docs system (I added one line to make it work). The constructor of Renderer and the blit methods are the only one currently referencing things that have not been ported. Tho it won't be like this anymore since the PRs to port them are already up. I can change if needed, but I don't think so as this is an experimental, privated module with a big warning.EDIT (also explaining things better after discussing with @Starbuck5): I removed _render from index.rst. I also removed render.rst. This means tat the only thing happening with this PR is that the stubs of _render start getting the docs of sdl2_video. When pygame.window was first born, it was still experimental, but it got the documentation, and eventually started getting features while sdl2_video.Window was left behind. _render, written properly in C, is the future replacement of some of the features of sdl2_video.video, which will be "left behind" as well (otherwise, what's even the point), meaning _render, which will become render when it is complete, require docs (and should use the new system). Sooner or later it must have docs. Now, since I'm using the new system, I can add docs without them existing in
pyga.me/docs
because as long as no render.rst exists, autoapi will not in fact make them exist. The module will stay private. This PR allows for _render to get docs gradually. Otherwise, some time in the future, Renderer, Texture, Image and whatever would have to get their docs all at once. If you are still confused I'm here to explain, or if you have concerns, I'm here for feedback!