Skip to content

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

Description

@pushfoo

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions