manim icon indicating copy to clipboard operation
manim copied to clipboard

Documentation error in `manim.mobject.types.image_mobject`

Open igreat opened this issue 3 years ago • 0 comments

    ...
    def interpolate_color(self, mobject1, mobject2, alpha):
        """Interpolates an array of pixel color values into another array of
        equal size.

        Parameters
        ----------
        mobject1 : ImageMobject
            The ImageMobject to transform from.

        mobject1 : ImageMobject

            The ImageMobject to transform into.
        alpha : float
            Used to track the lerp relationship. Not opacity related
       """

In the documentation, in the parameters section as you can see the second parameter is supposed to be mobject2 and not mobject1.

Also, don't you think it's a bit misleading to say that this "Interpolates an array of pixel color values into another array of equal size" when it seems to interpolate an ImageMobject into another?

I just started working with this a few minutes ago so I could be missing something here, just wanted to report this before I moved on from it!

igreat avatar Aug 08 '22 00:08 igreat