ManimCommunity / ManimCommunity/manim
Clean Up Manim's API
Open
@JasonGrace2282 is already working on this.
Since May 30, 2024.
documentation
enhancement
- Dominant language
- Python
- Stars
- 40.9k
- Forks
- 3.1k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 25
Description
Currently, it's difficult to tell which methods are internal to Manim, and which are designed to be used by an end user. Once the API of Manim is solidified, it's easier to make more drastic changes without having to worry about breaking user code, because all you have to do is *keep the public interface stable (ish)*.
Renaming methods to start with an `_` to avoid them being documented is not a good solution, as the documentation should be for both developers and end users.
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.
Assessment
This issue has not been assessed yet.