manim
manim copied to clipboard
Add docstring for `Mobject.rotate` and Refactor `Rotating` and also add its docstring
Overview: What does this pull request change?
- Adding detailed docstrings for the
.rotate()and related See also. - Refactor
Rotating, add docstring and related see also, and adjust Rotating parameter in Example Gallery. Breaking change:- renames the
radiansparameter toangleto be consistent with the.rotate()and theRotateclass. - reorders the arguments in the
RotatingBefore:Rotating(mobject, axis, radians, ...)After :Rotating(mobject, angle, axis, ...)
- renames the
Links to added or changed documentation pages
rotate: https://manimce--4147.org.readthedocs.build/en/4147/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject.rotateRotating: 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