Skip to content

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

Merged
merged 3 commits into from
Apr 19, 2021
Merged

DOC: fix link to io.zarr #5176

merged 3 commits into from
Apr 19, 2021

Conversation

raybellwaves
Copy link
Contributor

Fixes rendering in #5163

@max-sixty max-sixty requested a review from keewis April 17, 2021 00:52
@@ -1849,7 +1849,7 @@ def to_zarr(

See Also
--------
http://xarray.pydata.org/en/stable/io.html#zarr
:doc:`io.zarr`
Copy link
Contributor

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...

Copy link
Contributor Author

@raybellwaves raybellwaves Apr 17, 2021

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.

Copy link
Contributor

@zmoon zmoon Apr 17, 2021

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.

Copy link
Collaborator

@keewis keewis left a 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.

Copy link
Collaborator

@keewis keewis left a 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.

@keewis
Copy link
Collaborator

keewis commented Apr 19, 2021

thanks again, the docs look great.

@keewis keewis merged commit 486999c into pydata:master Apr 19, 2021
@zmoon
Copy link
Contributor

zmoon commented Apr 19, 2021

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.

@keewis just wondering, did you see my comments?. It doesn't matter in this case, but it might be relevant in others.

@keewis
Copy link
Collaborator

keewis commented Apr 19, 2021

sorry, no, I didn't. It's definitely something that is supported by the format (see a similar issue in numpydoc: numpy/numpydoc#232), so this seems like a bug in napoleon. Given that you already investigated the code of napoleon: do you want to send in a PR to fix that? If not, I can try to look into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants