manim icon indicating copy to clipboard operation
manim copied to clipboard

Add docstring for `Mobject.rotate` and Refactor `Rotating` and also add its docstring

Open irvanalhaq9 opened this issue 10 months ago • 0 comments

Overview: What does this pull request change?

  1. Adding detailed docstrings for the .rotate() and related See also.
  2. Refactor Rotating, add docstring and related see also, and adjust Rotating parameter in Example Gallery. Breaking change:
    • renames the radians parameter to angle to be consistent with the .rotate() and the Rotate class.
    • reorders the arguments in the Rotating Before: Rotating(mobject, axis, radians, ...) After : Rotating(mobject, angle, axis, ...)

Links to added or changed documentation pages

  1. rotate: https://manimce--4147.org.readthedocs.build/en/4147/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject.rotate
  2. Rotating: https://manimce--4147.org.readthedocs.build/en/4147/reference/manim.animation.rotation.Rotating.html#manim.animation.rotation.Rotating

Reviewer Checklist

  • [ ] The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • [ ] If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • [ ] If applicable: newly added functions and classes are tested

irvanalhaq9 avatar Feb 03 '25 09:02 irvanalhaq9