-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Allow passing iterables to Scene.add()
and improve comments for flatten_iterable_parameters()
#4190
Open
irvanalhaq9
wants to merge
20
commits into
ManimCommunity:main
Choose a base branch
from
irvanalhaq9:improve-use-flatten-iterable-parameters
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
Allow passing iterables to Scene.add()
and improve comments for flatten_iterable_parameters()
#4190
irvanalhaq9
wants to merge
20
commits into
ManimCommunity:main
from
irvanalhaq9:improve-use-flatten-iterable-parameters
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
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?
This PR allows
Scene.add()
to accept iterable inputs directly, without requiring explicit unpacking. It also improves comments forflatten_iterable_parameters()
inScene.compile_animations()
to clarify its purpose.Motivation and Explanation: Why and how do your changes improve the library?
Currently,
Scene.add()
requires unpacking when passing an iterable ofmobjects
(e.g.,self.add(*mobjects)
). This PR modifiesScene.add()
to useflatten_iterable_parameters()
, allowing users to pass iterables directly (e.g.,self.add(mobjects)
). This improves consistency withScene.play()
, which already supports this behavior.Additionally, comments for
flatten_iterable_parameters()
have been improved to clarify that it allows passing iterables—including generators—toself.play()
without explicit unpacking.self.play()
can already accept both unpacked and non-unpacked iterables because it utilizes functionflatten_iterable_parameters()
. This PR applies the same approach toself.add()
, allowing it to accept iterables directly without requiring unpacking.Enhancement: Allow
self.add()
to accept iterables without unpackingCurrent Behavior
Before this PR,
self.play()
already accepts both unpacked and non-unpacked iterables:With unpacking:
Without unpacking:
Both approaches work as expected.
However,
self.add()
requires unpacking:New Behavior
With this PR,
self.add()
can now accept iterables without unpacking:This change makes
self.add()
consistent withself.play()
in handling iterables.Reviewer Checklist