Improve docs and typings for mobject_update_utils
, and add examples for always()
, f_always()
and cycle_animation()
#3976
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?
always()
,cycle_animation()
andassert_is_mobject_method()
.Parameters
,Returns
andRaises
sections.always()
,f_always()
andcycle_animation()
.MobjectT
TypeVar
in order to get better typings for theMobject
s returned by functions such asalways_redraw()
. For example, if the lambda function insidealways_redraw()
returns aBrace
, theMobject
returned byalways_redraw()
is now recognized as aBrace
and, as such, autocompletion includesBrace
methods and attributes.Callable
s were missing parameter and return types.**kwargs
fromturn_animation_into_updater()
andcycle_animation()
.Links to added or changed documentation pages
https://manimce--3976.org.readthedocs.build/en/3976/reference/manim.animation.updaters.mobject_update_utils.html
Reviewer Checklist