Skip to content

Commit d3d4204

Browse files
committed
add docstring for Write
1 parent 7370918 commit d3d4204

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

manim/animation/creation.py

+17-1
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,23 @@ def interpolate_submobject(
294294

295295

296296
class Write(DrawBorderThenFill):
297-
"""Simulate hand-writing a :class:`~.Text` or hand-drawing a :class:`~.VMobject`.
297+
"""Simulate hand-writing a text-based mobject, such as :class:`~.Text`,
298+
:class:`~.MarkupText`, :class:`~.Tex`, :class:`~.MathTex`,
299+
or :class:`~.VMobject` in general.
300+
301+
Parameters
302+
----------
303+
vmobject
304+
The VMobject to animate.
305+
stroke_width
306+
Stroke width for drawing. If not given, for SVG-based mobjects (such as :class:`Text`, :class:`MarkupText`, or :class:`MathTex`)
307+
the stroke width is scaled relative to the font size. Others use 2.0.
308+
rate_func
309+
The function defining the animation progress.
310+
reverse
311+
If ``True``, plays the animation in reverse.
312+
**kwargs
313+
Additional arguments passed to the parent class :class:`~.DrawBorderThenFill`.
298314
299315
Examples
300316
--------

0 commit comments

Comments
 (0)