80 lines · 1.3 KB · Python
RawDownload
# see more documentation guidelines online here: https://github.com/ManimCommunity/manim/wiki/Documentation-guidelines-(WIP)  from __future__ import annotations  class SomeClass:    """A one line description of the Class.     A short paragraph providing more details.     Extended Summary     Parameters    ----------    scale_factor        The factor used for scaling.     Returns    -------    :class:`~.VMobject`        Returns the modified :class:`~.VMobject`.     Tests    -----     Yields    -------     Receives    ----------     Other Parameters    -----------------     Raises    ------    :class:`TypeError`        If one element of the list is not an instance of VMobject     Warns    -----     Warnings    --------     Notes    -----     Examples    --------    .. manim:: AddTextLetterByLetterScene        :save_last_frame:         class AddTextLetterByLetterScene(Scene):            def construct(self):                t = Text("Hello World word by word")                self.play(AddTextWordByWord(t))       See Also    --------    :class:`Create`, :class:`~.ShowPassingFlash`     References    ----------      Other useful directives:     .. tip::         This is currently only possible for class:`~.Text` and not for class:`~.MathTex`.     .. note::         This is something to note.     """