From c6e0935071af10d1f291cee0a25efa3e964d2cd9 Mon Sep 17 00:00:00 2001 From: Ray Bell Date: Fri, 8 Mar 2024 13:47:14 -0500 Subject: [PATCH] DOC: link to zarr.convenience.consolidate_metadata (#8816) * 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 Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- doc/conf.py | 22 +++++++++++----------- xarray/core/dataset.py | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 73b68f7f772..152eb6794b4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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), } diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index 895a357a240..bdb881278eb 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -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