Docstrings added/modified and some methods refactored#4683
Open
GoThrones wants to merge 19 commits intoManimCommunity:mainfrom
Open
Docstrings added/modified and some methods refactored#4683GoThrones wants to merge 19 commits intoManimCommunity:mainfrom
GoThrones wants to merge 19 commits intoManimCommunity:mainfrom
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…ttps://github.com/GoThrones/ManimCE into docstring_and_method_refactoring_in_VMobject_class
for more information, see https://pre-commit.ci
…ttps://github.com/GoThrones/ManimCE into docstring_and_method_refactoring_in_VMobject_class
for more information, see https://pre-commit.ci
…ttps://github.com/GoThrones/ManimCE into docstring_and_method_refactoring_in_VMobject_class
Contributor
Author
|
Doc build is getting terminated due to timeout. This is happening repeatedly. All other tests are getting timed out. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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?
This PR adds docstring to some methods, and refactors some of the methods, and in some cases, variable names have been improved. The changes are mostly in vectorized_mobject.py and some minor changes are in mobject.py and space_ops.py.
Motivation and Explanation: Why and how do your changes improve the library?
Many methods did not have docstrings. Some of the methods didn't have clear enough docstring.
Some methods, such as add_smooth_curve_to in VMobject class has been refactord as it didn't consider edge cases.
The method consider_points_equals in VMobject class has also been refactored to make it time efficient. Before refactoring, this method used np.allclose which was much slower compared to the current implementation.
Reviewer Checklist