Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring for Mobject.rotate and Rotating class #4147

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

irvanalhaq9
Copy link
Contributor

@irvanalhaq9 irvanalhaq9 commented Feb 3, 2025

Overview: What does this pull request change?

Adding detailed docstrings for the Mobject.rotate, also add docstring for Rotating class.

Breaking change:
This PR also renames the radians parameter to angle and reorders the arguments in the Rotating class to be consistent with the Mobject.rotate and the Rotate class.
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 irvanalhaq9 changed the title Add docstring for Mobject.rotate Add docstring for Mobject.rotate and Rotating class Feb 3, 2025
@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

2 participants