arcade icon indicating copy to clipboard operation
arcade copied to clipboard
verified publisher icon pythonarcade

Improve typing and doc for physics engines

Open pushfoo opened this issue 1 year ago • 1 comments

A follow-up to #1973 after reading through it.

Changes

  • [x] Add missing type hints to physics engines
  • [x] Rewrite existing docstrings for clarity
  • [x] Fix style and clarity issues in code
  • [x] Add comments to clarify actions in some places
  • [ ] Fix copy and pasted docstring comments in pymunk physics engine docstrings

Why

The physics engines are part of the most popular tutorial users interact with. Their doc and type annotations should live up to that to improve first-timer experience.

pushfoo avatar Feb 22 '24 05:02 pushfoo

Not actually good to go in its current state, but GitHub's maintainer ergonomics on drafts are bad.

pushfoo avatar Jun 27 '24 13:06 pushfoo

Superceded by #2185

pushfoo avatar Jul 03 '24 00:07 pushfoo