ManimCommunity / manim

A community-maintained Python framework for creating mathematical animations.
https://www.manim.community
MIT License
19.95k stars 1.48k forks source link

[Docs] Quickstart - Transform vs ReplacementTransform #3139

Closed DegrangeM closed 6 months ago

DegrangeM commented 1 year ago

In the quickstart tutorial https://docs.manim.community/en/stable/tutorials/quickstart.html

The transform method is introduced : https://docs.manim.community/en/stable/tutorials/quickstart.html#transforming-a-square-into-a-circle

A little after, in Using .animate syntax to animate methods, the ReplacementTransform method is used.

It is confusing for new learner because they don't know why this new function is used instead of the other.

The docs should either :

bdotsamir commented 7 months ago

image

This should be explained somewhere in the quickstart! This was a massive pain-point for me when I was learning Manim for the first time- I saw Transform used in 3b1b's videos and so that's what I used, but I was wondering why the design decision was to replace the original mobject with a reference to the transformed mobject. Caused headaches when I was trying to remember which variables held which Mobjects. ReplacementTransform solved this prayer.