Skip to content
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

rtd DataArray.to_netcdf #4413

Closed
raybellwaves opened this issue Sep 10, 2020 · 1 comment · Fixed by #4424
Closed

rtd DataArray.to_netcdf #4413

raybellwaves opened this issue Sep 10, 2020 · 1 comment · Fixed by #4424

Comments

@raybellwaves
Copy link
Contributor

http://xarray.pydata.org/en/stable/generated/xarray.DataArray.to_netcdf.html#xarray.DataArray.to_netcdf

I believe there is a way to hyperlink to xarray.Dataset.to_netcdf. I believe there is also a way for sphinx to render the Note section e.g. in the doc string add .. note::

@keewis
Copy link
Collaborator

keewis commented Sep 10, 2020

good catch, @raybellwaves. The link is missing a :py:meth: prefix and should be easy to fix.

However, the note is rendered that way because it is part of the Notes section, and might look strange because there's only that section. For example, in DataArray.map_blocks directly after it there's See Also. So I guess we could add a See Also section and/or copy the parameter documentation from Dataset.to_netcdf to fix this.

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 a pull request may close this issue.

2 participants