Made error message more helpful when cropping to a single pixel #869
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
nabobalis
reviewed
Jul 1, 2025
| @@ -127,7 +127,7 @@ def get_crop_item_from_points(points, wcs, crop_by_values, keepdims): | |||
| Denotes whether cropping is done using high-level objects or "values", | |||
| i.e. low-level objects. | |||
| keep_dims : `bool` | |||
| keepdims : `bool` | |||
There was a problem hiding this comment.
why is keepdims, not keep_dims?
There was a problem hiding this comment.
I'm simply making the docstring match the API.
There was a problem hiding this comment.
Yeah, this was more of a question for the two maintainers of ndcube than you.
@Cadair and @DanRyanIrish, explain yourselves.
nabobalis
approved these changes
Jul 1, 2025
|
Can we get a changelog please? |
|
Changelog entry added under |
Cadair
approved these changes
Jul 2, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/ndcube
that referenced
this pull request
Jul 2, 2025
…to a single pixel
Cadair
added a commit
that referenced
this pull request
Jul 2, 2025
…on-2.3 Backport PR #869 on branch 2.3 (Made error message more helpful when cropping to a single pixel)
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.
The error message when cropping to a single pixel does not currently make it clear that one can get the single pixel by setting
keepdims=True. This PR adds that helpful information. This PR also fixes a typo in the utility function's docstring.