arcade
arcade copied to clipboard
Doc: update ShapeList, ShapeElementList, and other doc with clearer mentions of pyglet.shapes
What needs improvement
The ShapeElement* doc mentions that these lists aren't updatable, but they don't include cross-reference:
A
ShapeElementListis a list of shapes that can be drawn together in a back for better performance.ShapeElementListsare 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 https://github.com/pyglet/pyglet/issues/1289 is merged upstream
Add cross-references to:
- https://pyglet.readthedocs.io/en/latest/programming_guide/shapes.html
- specific shapes in the https://pyglet.readthedocs.io/en/latest/modules/shapes.html