Open simplyrohan opened 1 year ago
Lots of content has accumulated in the documentation over time. I feel like more eyes on the docs with the current status of everything could rework descriptions to be more clear.
PRs welcome. Change could be as simple as doing one function/method.
I had a similar thought recently. I would be glad to revise some documentation, such as the blit documentation, to make it more beginner-friendly. Additionally, we should consider removing references to older versions of Pygame, as Pygame-ce's first version is 2.1.3. Listing previous versions wouldn't be very relevant and is just confunsing/of no use to new users. Here's an example that illustrates my point: In my opinion, it no longer serves a purpose to include versions other than Pygame-ce's versions beyond 2.1.3.
Looking into many of the sections in the current pygame-ce documentation from a beginner's viewpoint, it can seem absolutely terrifying. Some of the most fundamental
and simpleparts have been overcomplicated and the basics have been muddied. One of the most evident examples is thepygame.display.flip
doc. This is virtually the most important line in an app, but the description is extremely complicated. One sentence is dedicated to the main functionality! One!!! The rest is into the specifics. For a beginner looking into pygame for the first time, this is impossible!I think these should retain their current content but also get a few more sentences for the basics of what these methods do.
pygame.display
,pygame.math
,pygame.image
, andpygame.mixer
I know that this is vague, and doesn't give any specifics. But simply adding a sentence or two about the basic operation of these methods would do great.
Footnote: I know reference docs aren't a great place to start as a beginner, but it is the most obvious place to go.