Refactored arc.py file#4757
Open
GoThrones wants to merge 3 commits into
Open
Conversation
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
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?
All the changes in this PR are backwards compatible.
This PR has made following changes in arc.py file:
(1) Made 'tip_shape' and explicit parameter in CurvedArrow class.
(2) Made parameter named 'center' an explicit parameter for Circle class.
(3) Included deprecation warning for the parameters: 'dim_to_match' and 'stretch' in 'surround' method of Circle class as those parameters are not used at all.
(4) Made parameter named 'point' explicit in init of AnnotationDot class and in LabeledDot class.
(5) Wrote docstring for AnnotationDot class.
(6) 'center' an explicit parameter in Ellipse class, considering that Ellipse in ManimCE is just a circle which has been squashed and elongated in different directions.
(7) Made parameter named 'arc_center' explicit in init of AnnularSector class.
(8) made 'arc_center', 'start_angle' and 'angle' explicit parameter in init of Sector class.
(9) Wrote explanatory comment for why the points our outer_arc has been reversed, and why init_points has been written, in AnnularSector class.
(10) made 'center' an explicit parameter in Annulus class.
(11) wrote explanatory comment for why the points our 'inner_circle' has been reversed in Annulus class.
(12) Renamed 'tip_shap_start to' 'tip_shape_at_start' and 'tip_shape_end' to 'tip_shape_at_end' in init of CurvedDoubleArrow.
(13) Also, modified one test files.
(14) Few minor modifications here and there.
Motivation and Explanation: Why and how do your changes improve the library?
Explicit parameters make it easier for users to understand which arguments can be provided, without going through the source code of manimce.
Reviewer Checklist