Add docstring for Mobject.rotate and Rotating class
#4147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
…into add-rotate-docs
for more information, see https://pre-commit.ci
irvanalhaq9
changed the title
Mobject.rotate and Rotating class
|
Also add docstring for |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
irvanalhaq9
commented
Feb 4, 2025
| @@ -1011,7 +1011,7 @@ def dot_position(mobject): | |||
| label.add_updater(dot_position) | |||
| self.add(dot, label) | |||
| self.play(Rotating(dot, about_point=ORIGIN, angle=TAU, run_time=TAU, rate_func=linear)) | |||
| self.play(Rotating(dot, about_point=ORIGIN, radians=TAU, run_time=TAU, rate_func=linear)) | |||
There was a problem hiding this comment.
This fixes an incorrect parameter in the documentation example of add_updater. The Rotating class uses radians instead of angle as its parameter.
irvanalhaq9
commented
Feb 4, 2025
| @@ -3143,7 +3203,7 @@ def override_animate(method) -> types.FunctionType: | |||
| .. seealso:: | |||
| :attr:`Mobject.animate` | |||
| :attr:`~.Mobject.animate` | |||
There was a problem hiding this comment.
Adding a tilde (~) so that the rendered documentation displays only animate instead of Mobject.animate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
Adding detailed docstrings for the
rotatemethod inMobjectclass . Also add docstring forRotatingclass, including2Dand3Drotation examples.Reviewer Checklist