lordmauve / lordmauve/pgzero

Copy animation plots/color reference from Wasabi2D

Open
#350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
611
Forks
211
PR merge metrics
No merged PRs in 30d

Description

Wasabi2D inherited the animation functions but I wrote [better documentation](https://wasabi2d.readthedocs.io/en/stable/animation.html).

Additionally it includes [a table of Pygame's colour names](https://wasabi2d.readthedocs.io/en/stable/colors_ref.html).

We should merge that documentation into the pgzero docs.

The table is hard-coded in [animation.rst](https://raw.githubusercontent.com/lordmauve/wasabi2d/refs/heads/master/docs/animation.rst) but the plots are generated with scripts and called in the makefile

https://github.com/lordmauve/wasabi2d/blob/9d650aa0b7419d034769c2ed8a0b1cf41ebed713/docs/Makefile#L17-L19

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the linked Wasabi2D docs/animation.rst and docs/Makefile lines 17–19 to understand the hard-coded colour table and generated animation plots. Then locate the corresponding pgzero documentation and merge both references, including the plots and Pygame colour names. Done means the pgzero docs contain the improved animation documentation and colour reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.