Remove erroneous ij indexing from readme example #27
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.
Describe your changes
The readme currently features example code that creates the xy coordinate grid using
np.meshgrid(..., indexing='ij')
. This is a mismatch with the way we handle the coordinates in the xy array, where e.g.xy[0]
should contain x-coordinates.This fixes this problem by just removing the indexing argument. It's good to fix this to avoid confusing users who test out the code in the readme.
Issue Link
No issue for this.
Type of change
Checklist before requesting a review
pull
with--rebase
option if possible).For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned valuesI have placed in-line comments to clarify the intent of any hard-to-understand passages of my codeI have added tests that prove my fix is effective or that my feature worksChecklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee