diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index f667b7a..9f045ef 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -5,6 +5,7 @@ Changelog X.Y.Z (DD-MM-YYYY) ------------------ +* Change ``partition_chunks`` to ``preferred_chunks`` (:pr:`44`) * Allow arcae to vary in the 0.2.x range (:pr:`42`) * Pin xarray to 2024.9.0 (:pr:`42`) * Add test case for irregular grids (:pr:`39`, :pr:`40`, :pr:`41`) diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 97cd33c..8a6b9a7 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -116,7 +116,7 @@ to specify different chunking setups for each partition. (("DATA_DESC_ID", 1),): {"time": 3, "frequency": 2}}) See the ``preferred_chunks`` argument of -:meth:`xarray_ms.backend.msv2.entrypoint.MSv2EntryPoint.open_datatree` +:meth:`~xarray_ms.backend.msv2.entrypoint.MSv2EntryPoint.open_datatree` for more information. .. ipython:: python diff --git a/xarray_ms/backend/msv2/entrypoint.py b/xarray_ms/backend/msv2/entrypoint.py index 8ec2547..5356fdc 100644 --- a/xarray_ms/backend/msv2/entrypoint.py +++ b/xarray_ms/backend/msv2/entrypoint.py @@ -351,9 +351,12 @@ def open_datatree( "D=0,F=1": {{"time": 20, "frequency": 32}}, }} - .. note:: This argument should be used in conjunction with - the reserved ``chunks`` argument used by xarray to control chunking - in Datasets and DataTrees. See preferred_chunk_sizes_ for more information. + .. note:: xarray's reserved ``chunks`` argument must be specified in order + to enable this functionality and enable fine-grained chunking + in Datasets and DataTrees. + See xarray's backend documentation on + `Preferred chunk sizes `_ + for more information. drop_variables: Variables to drop from the dataset. partition_columns: The columns to use for partitioning the Measurement set.