ManimCommunity / ManimCommunity/manim

Issues in Transform docs?

Open
#3,478 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
40.9k
Forks
3.1k
Avg merge
3d 12h
Merged PRs (30d)
25

Description

The docs of [Transform](https://docs.manim.community/en/stable/reference/manim.animation.transform.Transform.html?highlight=Transform#transform) are a bit confusing.

The current signature in the docs is:

`class Transform(mobject=None, *args, use_override=True, **kwargs)`

but then the following list of parameters does not really match:
```
PARAMETERS:

- mobject ([Mobject](https://docs.manim.community/en/stable/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject) | None) – The [Mobject](https://docs.manim.community/en/stable/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject) to be transformed. It will be mutated to become the target_mobject.

- target_mobject ([Mobject](https://docs.manim.community/en/stable/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject) | None) – The target of the transformation.

- path_func (Callable | None) – A function defining the path that the points of the mobject are being moved along until they match the points of the target_mobject, see [utils.paths](https://docs.manim.community/en/stable/reference/manim.utils.paths.html#module-manim.utils.paths).

- path_arc (float) – The arc angle (in radians) that the points of mobject will follow to reach the points of the target if using a circular path arc, see path_arc_centers. See also [manim.utils.paths.path_along_arc()](https://docs.manim.community/en/stable/reference/manim.utils.paths.html#manim.utils.paths.path_along_arc).

- path_arc_axis (np.ndarray) – The axis to rotate along if using a circular path arc, see path_arc_centers.

- path_arc_centers (np.ndarray) –

The center of the circular arcs along which the points of mobject are moved by the transformation.

If this is set and path_func is not set, then a path_along_circles path will be generated using the path_arc parameters and stored in path_func. If path_func is set, this and the other path_arc fields are set as attributes, but a path_func is not generated from it.

- replace_mobject_with_target_in_scene (bool) –

Controls which mobject is replaced when the transformation is complete.

If set to True, mobject will be removed from the scene and target_mobject will replace it. Otherwise, target_mobject is never added and mobject just takes its shape.
```

Contributor guide

Open the contributing guide

Research direction

Start with the Transform reference page and compare its displayed signature with the listed parameters. Check the Transform documentation source or generated API description to determine which signature and parameter descriptions are authoritative, then update the documentation so they agree and verify the rendered page.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.