Skip to content

DOC: fix link to io.zarr - #5176

Merged
keewis merged 3 commits into
pydata:masterfrom
raybellwaves:patch-5
Apr 19, 2021
Merged

DOC: fix link to io.zarr#5176
keewis merged 3 commits into
pydata:masterfrom
raybellwaves:patch-5

Conversation

@raybellwaves

Copy link
Copy Markdown
Contributor

Fixes rendering in #5163

@max-sixty
max-sixty requested a review from keewisApril 17, 2021 00:52
Comment threadxarray/core/dataset.py Outdated
See Also
--------
http://xarray.pydata.org/en/stable/io.html#zarr
:doc:`io.zarr`

Copy link
Copy Markdown
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...

@raybellwavesraybellwavesApr 17, 2021

Copy link
Copy Markdown
ContributorAuthor

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.

@zmoonzmoonApr 17, 2021

Copy link
Copy Markdown
Contributor

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.

Comment threadxarray/core/dataset.py

@keewiskeewis left a comment

Copy link
Copy Markdown
Collaborator

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.

Comment threadxarray/core/dataset.py
Co-authored-by: keewis <keewis@users.noreply.github.com>

@keewiskeewis left a comment

Copy link
Copy Markdown
Collaborator

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
Copy Markdown
Collaborator

thanks again, the docs look great.

@keewis
keewis merged commit 486999c into pydata:masterApr 19, 2021
@zmoon

Copy link
Copy Markdown
Contributor

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

keewis commented Apr 19, 2021

Copy link
Copy Markdown
Collaborator

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

@raybellwaves@keewis@zmoon