Skip to content

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

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

Open
wants to merge 2 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?

  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 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
@github-project-automation github-project-automation bot moved this to 🆕 New in Dev Board Apr 5, 2025
@irvanalhaq9 irvanalhaq9 force-pushed the add-rotate-docs branch 2 times, most recently from b93569b to 7edb2c3 Compare April 20, 2025 17:46
@irvanalhaq9 irvanalhaq9 changed the title Add docstring for Mobject.rotate and Rotating class Add docstring for Mobject.rotate and Refactor Rotating and also add its docstring Apr 20, 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