DOC: rework 'Writing custom array containers' guide #30322
+74
−295
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
Migrate the __array__() DiagonalArray example from basics.dispatch.rst to arrays.classes.rst where it documents the class.__array__ interface. Reduce basics.dispatch.rst, removing redundant content already covered in basics.interoperability.rst while preserving unique testing utilities documentation. Update cross-reference in basics.interoperability.rst to point to the new example location. See numpy#29258
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This Pull Request addresses issue #29258, which requested reorganizing the "Writing custom array containers" guide to reduce duplication with the interoperability documentation.
The changes include:
Migrated the
__array__()example: The DiagonalArray example has been moved frombasics.dispatch.rsttoarrays.classes.rst, where it now documents theclass.__array__()method in the reference guide.Reduced
basics.dispatch.rstto a navigation stub: The file has been reduced as a stub.Updated cross-reference: Modified
basics.interoperability.rstto reference the new example location instead of the oldbasics.dispatchpage.Files Modified
doc/source/reference/arrays.classes.rst- Added DiagonalArray exampledoc/source/user/basics.dispatch.rst- Reduced to navigation stubdoc/source/user/basics.interoperability.rst- Updated cross-referenceRelated Issues
Closes #29258