-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Improve docstring for interpolate
method in Mobject
class
#4149
Open
irvanalhaq9
wants to merge
22
commits into
ManimCommunity:main
Choose a base branch
from
irvanalhaq9:improve-docstring-interpolate
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Improve docstring for interpolate
method in Mobject
class
#4149
irvanalhaq9
wants to merge
22
commits into
ManimCommunity:main
from
irvanalhaq9:improve-docstring-interpolate
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
Improve docstring for
interpolate
method inMobject
classImprovements:
This PR improves the documentation by explicitly stating that
mobject1
andmobject2
must have the same number of points to avoid errors. It also provides a clear recommendation to use.align_points()
when necessary.Additionally, the updated example is more representative, demonstrating both cases: when point alignment is not needed (e.g.,
Dot
) and when it is required (e.g.,Line → Square
). This makes it easier for users to understand when manual alignment is necessary.A
See Also
section has been added to reference related methods, helping users explore relevant functionality more efficiently.Links to added or changed documentation pages
Method
interpolate
: https://manimce--4149.org.readthedocs.build/en/4149/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject.interpolateReviewer Checklist