Minor docstring formatting fixes, refactor input argument validation, and fix bug when tracing in +/-1 direction #172
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
nabobalis
previously approved these changes
Oct 3, 2024
wtbarnes
changed the title
Cadair
requested changes
Oct 14, 2024
|
I've added docstrings for all the new properties. I'm not sure why the RTD build is failing... |
|
Just needs a kick. |
Cadair
approved these changes
Oct 16, 2024
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.
This PR does
twothree things:VectorGridandStreamtracer. Also movedxsandROTto be properties so that their attribute docstrings render more nicely.VectorGrid. Previously, the validation was done using a mix of some setters and some static validation methods. This refactor moves all of the validation to setter methods.Streamtracer.trace()in thedirection=+/-1cases where the streamlines were trying to be returned as an array, but were failing because each array within that array was of unequal length. This returns them as a list, consistent with thedirection=0case. Maybe this needs a test? If it was already covered, I'm not sure how it was passing previously. I could move this to a separate PR if that is preferable.