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

Polish documentation of manim.utils.color.core and remove interpolate_array() #4065

Merged
merged 12 commits into from
Jan 19, 2025

Conversation

chopan050
Copy link
Contributor

@chopan050 chopan050 commented Dec 19, 2024

EDIT: PR #3999 already typed the entire manim.utils module, including manim.utils.color.core, before I did. Therefore, I changed this PR's name to focus on the other things it does: polish docs and remove interpolate_array().

  • Stopped ignoring MyPy errors for manim.utils.color.
  • Fixed MyPy errors in manim.utils.color.core.
  • Removed the manim.utils.color.core.interpolate_array() function, because manim.utils.bezier.interpolate() already exists and provides the exact same functionality.
  • The docs were rewritten a bit to comply more with standards.

Links to added or changed documentation pages

https://manimce--4065.org.readthedocs.build/en/4065/reference/manim.utils.color.core.html

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a coarse reading of the documentation changes and reviewed the typing changes -- thanks for the hard work with the color module, this is a substantial improvement!

Given that the docs seem fine and mypy appears happy, I'm merging this.

@behackl behackl merged commit 765c090 into ManimCommunity:main Jan 19, 2025
19 of 20 checks passed
@chopan050 chopan050 changed the title Complete typing of manim.utils.color and polish its documentation Polish documentation of manim.utils.color and remove interpolate_array() Jan 19, 2025
@chopan050 chopan050 changed the title Polish documentation of manim.utils.color and remove interpolate_array() Polish documentation of manim.utils.color.core and remove interpolate_array() Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants