Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up Manim's API #3792

Open
JasonGrace2282 opened this issue May 30, 2024 · 0 comments
Open

Clean Up Manim's API #3792

JasonGrace2282 opened this issue May 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement Additions and improvements in general

Comments

@JasonGrace2282
Copy link
Contributor

JasonGrace2282 commented May 30, 2024

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.

@JasonGrace2282 JasonGrace2282 added documentation Improvements or additions to documentation enhancement Additions and improvements in general labels May 30, 2024
@JasonGrace2282 JasonGrace2282 self-assigned this May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Additions and improvements in general
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant