arcade icon indicating copy to clipboard operation
arcade copied to clipboard

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

Open pushfoo opened this issue 9 months ago • 0 comments

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 https://github.com/pyglet/pyglet/issues/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

pushfoo avatar Mar 13 '25 03:03 pushfoo