Skip to content

Doc: update ShapeList, ShapeElementList, and other doc with clearer mentions of pyglet.shapes #2608

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

Open
pushfoo opened this issue Mar 13, 2025 · 0 comments

Comments

@pushfoo
Copy link
Member

pushfoo commented Mar 13, 2025

What needs improvement

The ShapeElement* doc mentions that these lists aren't updatable, but they don't include cross-reference:

A ShapeElementList is a list of shapes that can be drawn together in a back for better performance. ShapeElementLists are suited for drawing a large number of shapes that are static. If you need to move a lot of shapes it’s better to use pyglet’s shape system.

Proposed fix

Note

This is best handled after a fix for pyglet/pyglet#1289 is merged upstream

Add cross-references to:

  1. https://pyglet.readthedocs.io/en/latest/programming_guide/shapes.html
  2. specific shapes in the https://pyglet.readthedocs.io/en/latest/modules/shapes.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant