-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
Added DOC string for all the geometric objects. #1024
base: master
Are you sure you want to change the base?
Conversation
Earlier only ndarray could be used as arguments for some geometric objects, for eg:- starting and ending point of Line object. Now any array_like object can be used.
because there arguments were already compatible with array_like objects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than maybe changing requirements
-> parameters
great job and thank you for the documentation really helps a ton!
manimlib/mobject/geometry.py
Outdated
Returns | ||
----- | ||
out : Arc object | ||
An Arc object satisfying the specified requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe requirements
-> parameters
so it can match whats above same thing for the other blocks of comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I make a new pull request changing requirements
to parameters
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nah just making a commit and pushing to the existing branch should be sufficient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good nice job 👌
* Migrate width/height/depth to properties * Fix examples * Fix typos * Import manim for doctests * Expect Square for doctests * Improve docs for width/height/depth properties
Added DOC string for all the geometric objects.
Earlier only ndarray could be used as arguments for ArcBetweenPoints instance.
For eg:-
arc = ArcBetweenPoints(start = (1,2,0), end = (-2,-3,0), angle = 30 * DEGREES)
would give error. But after the changes it works fine.
Thanks for contributing to manim!
Please ensure that your pull request works with the latest version of manim.
You should also include:
screenshots, gifs, commands, etc.) This is rather informal at the moment, but
the goal is to show us how you know the pull request works as intended.