Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Follow-up to :pr:`2988` -- fixes and improvements to some docstrings (#3018)

Benjamin Hackl457da140055b
diff --git a/manim/animation/animation.py b/manim/animation/animation.py
index b35c67405..286bca5fe 100644
--- a/manim/animation/animation.py
+++ b/manim/animation/animation.py
@@ -416,7 +416,8 @@ class Animation:
Parameters
----------
rate_func
- The new function defining the animation progress based on the relative runtime (see :mod:`~.rate_functions`).
+ The new function defining the animation progress based on the
+ relative runtime (see :mod:`~.rate_functions`).
Returns
-------
diff --git a/manim/camera/camera.py b/manim/camera/camera.py
index cdc625cc2..1128ea612 100644
--- a/manim/camera/camera.py
+++ b/manim/camera/camera.py
@@ -36,6 +36,21 @@ class Camera:
This is the object which takes care of what exactly is displayed
on screen at any given moment.
+
+ Parameters
+ ----------
+ background_image
+ The path to an image that should be the background image.
+ If not set, the background is filled with :attr:`self.background_color`
+ background
+ What :attr:`background` is set to. By default, ``None``.
+ pixel_height
+ The height of the scene in pixels.
+ pixel_width
+ The width of the scene in pixels.
+ kwargs
+ Additional arguments (``background_color``, ``background_opacity``)
+ to be set.
"""
def __init__(
@@ -55,22 +70,6 @@ class Camera:
frame_rate: float | None = None,
**kwargs,
):
- """Initialises the Camera.
-
- Parameters
- ----------
- background_image
- The path to an image that should be the background image.
- If not set, the background is filled with `self.background_color`
- background
- What self.background should be, by default None as will be set later.
- pixel_height
- The height of the scene in pixels.
- pixel_width
- The width of the scene in pixels.
- **kwargs
- Any local variables to be set.
- """
self.background_image = background_image
self.frame_center = frame_center
self.image_mode = image_mode
@@ -100,6 +99,7 @@ class Camera:
frame_rate = config["frame_rate"]
self.frame_rate = frame_rate
+ # TODO: change this to not use kwargs.get
for attr in ["background_color", "background_opacity"]:
setattr(self, f"_{attr}", kwargs.get(attr, config[attr]))
diff --git a/manim/mobject/types/image_mobject.py b/manim/mobject/types/image_mobject.py
index c0eff69c2..091c60a19 100644
--- a/manim/mobject/types/image_mobject.py
+++ b/manim/mobject/types/image_mobject.py
@@ -67,6 +67,7 @@ class AbstractImageMobject(Mobject):
An integer constant described in the Pillow library,
or one from the RESAMPLING_ALGORITHMS global dictionary,
under the following keys:
+
* 'bicubic' or 'cubic'
* 'nearest' or 'none'
* 'box'
diff --git a/manim/scene/scene.py b/manim/scene/scene.py
index 63a718b08..103a6a62d 100644
--- a/manim/scene/scene.py
+++ b/manim/scene/scene.py
@@ -1123,7 +1123,7 @@ class Scene:
animations
Animation or mobject with mobject method and params
play_kwargs
- named parameters affecting what was passed in ``animations``,
+ Named parameters affecting what was passed in ``animations``,
e.g. ``run_time``, ``lag_ratio`` and so on.
Returns