Refactored the code and improved the docstring of vector_field.py#4705
Open
GoThrones wants to merge 2 commits intoManimCommunity:mainfrom
Open
Refactored the code and improved the docstring of vector_field.py#4705GoThrones wants to merge 2 commits intoManimCommunity:mainfrom
GoThrones wants to merge 2 commits intoManimCommunity:mainfrom
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?
This PR makes a minor alteration in the code of ArrowVectorField class and StreamLines class. Improves the docstring of all three classes in vector_field.py
Motivation and Explanation: Why and how do your changes improve the library?
The code related to x, y and z ranges was duplicated in ArrowVectorField class and StreamLines class. I've put that code in VectorField class, and the ArrowVectorField and StreamLines class invoke the method _setup_ranges() to setup the ranges.
The docstring were misleading at few places. The parameters were not explained properly.
Links to added or changed documentation pages
Further Information and Comments
Reviewer Checklist