-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
DOC: fix link to io.zarr #5176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: fix link to io.zarr #5176
Conversation
xarray/core/dataset.py
Outdated
@@ -1849,7 +1849,7 @@ def to_zarr( | |||
|
|||
See Also | |||
-------- | |||
http://xarray.pydata.org/en/stable/io.html#zarr | |||
:doc:`io.zarr` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This gave WARNING: unknown document: io.zarr
. It should work with :ref:
instead of :doc:
I believe...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @zmoon. Apologies, i'm by lazy here and didn't build the docs. You want to make a PR to my branch? Was going to take a look when the rtd builds but it's slow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raybellwaves I am also being lazy, I saw the message in the rtd log. I don't know why it still says pending, but it seems to have failed-on-warning after 10 minutes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the fix, @raybellwaves. I agree with @zmoon that other API pages might benefit from these links, too, as long as we remember to sufficiently describe the link so the entry is still useful in text mode.
Co-authored-by: keewis <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the update, @raybellwaves. I'm going to merge once the RTD build succeeds.
thanks again, the docs look great. |
@keewis just wondering, did you see my comments?. It doesn't matter in this case, but it might be relevant in others. |
sorry, no, I didn't. It's definitely something that is supported by the format (see a similar issue in |
Fixes rendering in #5163