ManimCommunity / ManimCommunity/manim
Move methods out of `CoordinateSystem`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 40.9k
- Forks
- 3.1k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 25
Description
## Enhancement proposal
Currently, it can be pretty challenging to a get a broad sense of everything related to graphing in the docs since quite a few methods are under `CoordinateSystem`, while the rest are under `Axes`. Also, for example, looking for `coords_to_point` under `CoordinateSystem` would suggest that it isn't documented and is `NotImplemented`, but the real docs are in `Axes`
There are also some PolarPlane methods that don't really belong under `CoordinateSystem`.
Here's my suggestion:
- Move methods out of `CoordinateSystem` and into `Axes`/`PolarPlane` (where applicable)
- *Maybe* make CoordinateSystem private?
- *Maybe* remove `CoordinateSystem` all together?
- Every graph class subclasses `Axes` anyway.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the CoordinateSystem, Axes, and PolarPlane implementations and comparing where their graphing methods are currently defined and documented. Done means moving applicable methods to Axes or PolarPlane, while resolving whether CoordinateSystem should remain private or be removed; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-graphics
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100