Add comment to Mobject.animate

HarryE2009 · Mar 7, 2024 · 3c778ba · 3c778ba
1 parent a6b46c6
commit 3c778ba
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/manimlib/mobject/mobject.py b/manimlib/mobject/mobject.py
@@ -159,7 +159,13 @@ def set_uniforms(self, uniforms: dict) -> Self:
 
     @property
     def animate(self) -> _AnimationBuilder:
-        # Borrowed from https://github.com/ManimCommunity/manim/
+        """
+        Methods called with Mobject.animate.method() can be passed
+        into a Scene.play call, as if you were calling 
+        ApplyMethod(mobject.method)
+
+        Borrowed from https://github.com/ManimCommunity/manim/
+        """
         return _AnimationBuilder(self)
 
     @property