Skip to content

Commit

Permalink
DOC: link to zarr.convenience.consolidate_metadata (#8816)
Browse files Browse the repository at this point in the history
* link to zarr.convenience.consolidate_metadata

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Ray Bell <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 8, 2024
1 parent 8468be0 commit c6e0935
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -316,22 +316,22 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
"cftime": ("https://unidata.github.io/cftime", None),
"cubed": ("https://cubed-dev.github.io/cubed/", None),
"dask": ("https://docs.dask.org/en/latest", None),
"datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),
"flox": ("https://flox.readthedocs.io/en/latest/", None),
"hypothesis": ("https://hypothesis.readthedocs.io/en/latest/", None),
"iris": ("https://scitools-iris.readthedocs.io/en/latest", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"numba": ("https://numba.readthedocs.io/en/stable/", None),
"numpy": ("https://numpy.org/doc/stable", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
"python": ("https://docs.python.org/3/", None),
"scipy": ("https://docs.scipy.org/doc/scipy", None),
"numba": ("https://numba.readthedocs.io/en/stable/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"dask": ("https://docs.dask.org/en/latest", None),
"cftime": ("https://unidata.github.io/cftime", None),
"sparse": ("https://sparse.pydata.org/en/latest/", None),
"hypothesis": ("https://hypothesis.readthedocs.io/en/latest/", None),
"cubed": ("https://cubed-dev.github.io/cubed/", None),
"datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),
"xarray-tutorial": ("https://tutorial.xarray.dev/", None),
"flox": ("https://flox.readthedocs.io/en/latest/", None),
# "opt_einsum": ("https://dgasmith.github.io/opt_einsum/", None),
"zarr": ("https://zarr.readthedocs.io/en/latest/", None),
}


Expand Down
2 changes: 1 addition & 1 deletion xarray/core/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -2417,7 +2417,7 @@ def to_zarr(
``dask.delayed.Delayed`` object that can be computed to write
array data later. Metadata is always updated eagerly.
consolidated : bool, optional
If True, apply zarr's `consolidate_metadata` function to the store
If True, apply :func:`zarr.convenience.consolidate_metadata`
after writing metadata and read existing stores with consolidated
metadata; if False, do not. The default (`consolidated=None`) means
write consolidated metadata and attempt to read consolidated
Expand Down

0 comments on commit c6e0935

Please sign in to comment.