ManimCommunity / ManimCommunity/manim
Rename cryptically named functions and variables
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
Manim is filled with cryptically named functions and variables. Some examples include `pointwise_become_partial` and `digest_args`. Such unhelpful names significantly lower code readability and is a major obstacle to understanding the internals of Manim. They should be renamed so that their role or purpose is, as far as possible, clear from first glance.
## Additional comments
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 locating the cited functions `pointwise_become_partial` and `digest_args`, then inventory the other cryptically named functions and variables across Manim. Clarify the intended rename scope and naming decisions before changing anything. Done means the agreed names communicate each item's role clearly without leaving inconsistent references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-graphics
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100