reword eachslice docs to allow other slices objects #57428
Merged
+5
−5
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
LilithHafner
added
docs
LilithHafner
approved these changes
Feb 16, 2025
|
While this is technically breaking I think it is clearly a good idea. |
Co-authored-by: Lilith Orion Hafner <[email protected]>
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 wording of
eachsliceis overly strict in enforcing aSlicesreturn type, instead of allowing other objects with similar behavior but e.g. potentially additional behaviors. The existence ofAbstractSlicessuggests this was actually intended at some stage but did not make it into the docs.AxisKeys.jl already returns something else and it seems not to cause any problems, but it would be good to be able to do this without breaking the documented contract of the method.
Closes #57206