Add cross-links for apply_ufunc in top-level API documentation#11063
Merged
max-sixty merged 6 commits intopydata:mainfrom Jan 2, 2026
Merged
Add cross-links for apply_ufunc in top-level API documentation#11063max-sixty merged 6 commits intopydata:mainfrom
max-sixty merged 6 commits intopydata:mainfrom
Conversation
|
Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient. |
for more information, see https://pre-commit.ci
dcherian
reviewed
Dec 31, 2025
dcherian
reviewed
Dec 31, 2025
Contributor
Author
|
Thanks for the suggestions! |
dcherian
reviewed
Jan 2, 2026
doc/api/top-level.rst
Outdated
| For worked examples and advanced usage of ``apply_ufunc``, see the | ||
| :doc:`User Guide on Computation </user-guide/computation>`, | ||
|
|
||
| the tutorial examples at https://tutorial.xarray.dev/advanced/apply_ufunc/apply_ufunc.html. |
Contributor
There was a problem hiding this comment.
Can we format this URL nicely please?
Contributor
Author
|
I’ve updated the raw link to a named reST link. |
|
Congratulations on completing your first pull request! Welcome to Xarray! We are proud of you, and hope to see you again! |
Contributor
Author
|
Thanks for the review and merge. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 adds a short note in the top-level API documentation linking
apply_ufuncto the User Guide, tutorial site, and Gallery example.This builds on earlier docstring-level cross-linking (e.g. #8311) and makes it easier for users to find related documentation when starting from the API reference, as discussed in #8008.
Scope is intentionally small and focused.