diff --git a/doc/internals/how-to-create-custom-index.rst b/doc/internals/how-to-create-custom-index.rst index 688a80193e4..351694fc62d 100644 --- a/doc/internals/how-to-create-custom-index.rst +++ b/doc/internals/how-to-create-custom-index.rst @@ -53,8 +53,8 @@ number, order and dimensions of the coordinates are all arbitrary), it is the responsibility of the index to check the consistency and validity of those input coordinates. -For example, :py:class:`~xarray.core.indexes.PandasIndex` accepts only one coordinate and -:py:class:`~xarray.core.indexes.PandasMultiIndex` accepts one or more 1-dimensional coordinates that must all +For example, :py:class:`~xarray.indexes.PandasIndex` accepts only one coordinate and +:py:class:`~xarray.indexes.PandasMultiIndex` accepts one or more 1-dimensional coordinates that must all share the same dimension. Other, custom indexes need not have the same constraints, e.g., diff --git a/doc/internals/internal-design.rst b/doc/internals/internal-design.rst index cb86424b405..0785535d51c 100644 --- a/doc/internals/internal-design.rst +++ b/doc/internals/internal-design.rst @@ -86,9 +86,9 @@ DataArray Objects The simplest data structure used by most users is :py:class:`~xarray.DataArray`. A :py:class:`~xarray.DataArray` is a composite object consisting of multiple -:py:class:`~xarray.core.variable.Variable` objects which store related data. +:py:class:`~xarray.Variable` objects which store related data. -A single :py:class:`~xarray.core.Variable` is referred to as the "data variable", and stored under the :py:attr:`~xarray.DataArray.variable`` attribute. +A single :py:class:`~xarray.Variable` is referred to as the "data variable", and stored under the :py:attr:`~xarray.DataArray.variable`` attribute. A :py:class:`~xarray.DataArray` inherits all of the properties of this data variable, i.e. ``dims``, ``data``, ``attrs`` and ``encoding``, all of which are implemented by forwarding on to the underlying ``Variable`` object. @@ -111,7 +111,7 @@ Finally a :py:class:`~xarray.DataArray` defines a :py:attr:`~xarray.DataArray.na variable but is stored on the wrapping ``DataArray`` class. The ``name`` attribute is primarily used when one or more :py:class:`~xarray.DataArray` objects are promoted into a :py:class:`~xarray.Dataset` (e.g. via :py:meth:`~xarray.DataArray.to_dataset`). -Note that the underlying :py:class:`~xarray.core.Variable` objects are all unnamed, so they can always be referred to uniquely via a +Note that the underlying :py:class:`~xarray.Variable` objects are all unnamed, so they can always be referred to uniquely via a dict-like mapping. .. _internal design.dataset: diff --git a/doc/internals/interoperability.rst b/doc/internals/interoperability.rst index 5c14819fa0d..ee5afe16426 100644 --- a/doc/internals/interoperability.rst +++ b/doc/internals/interoperability.rst @@ -10,7 +10,7 @@ This interoperability comes via a set of flexible abstractions into which the us - :ref:`Custom file backends ` via the :py:class:`~xarray.backends.BackendEntrypoint` system, - Numpy-like :ref:`"duck" array wrapping `, which supports the `Python Array API Standard `_, -- :ref:`Chunked distributed array computation ` via the :py:class:`~xarray.core.parallelcompat.ChunkManagerEntrypoint` system, +- :ref:`Chunked distributed array computation ` via the :py:class:`~xarray.namedarray.parallelcompat.ChunkManagerEntrypoint` system, - Custom :py:class:`~xarray.Index` objects for :ref:`flexible label-based lookups `, - Extending xarray objects with domain-specific methods via :ref:`custom accessors `. diff --git a/doc/user-guide/combining.rst b/doc/user-guide/combining.rst index 1dad2009665..53d5fc17cbd 100644 --- a/doc/user-guide/combining.rst +++ b/doc/user-guide/combining.rst @@ -22,7 +22,7 @@ Combining data Concatenate ~~~~~~~~~~~ -To combine :py:class:`~xarray.Dataset`s / :py:class:`~xarray.DataArray`s along an existing or new dimension +To combine :py:class:`~xarray.Dataset` / :py:class:`~xarray.DataArray` objects along an existing or new dimension into a larger object, you can use :py:func:`~xarray.concat`. ``concat`` takes an iterable of ``DataArray`` or ``Dataset`` objects, as well as a dimension name, and concatenates along that dimension: diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 4dc7ed7310f..7b950f5ef6b 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -40,6 +40,8 @@ Bug fixes Documentation ~~~~~~~~~~~~~ +- Fix references to core classes in docs (:issue:`10195`, :pull:`10207`). + By `Mattia Almansi `_. Internal Changes ~~~~~~~~~~~~~~~~ @@ -480,7 +482,7 @@ Documentation Internal Changes ~~~~~~~~~~~~~~~~ -- ``persist`` methods now route through the :py:class:`xr.core.parallelcompat.ChunkManagerEntrypoint` (:pull:`9682`). +- ``persist`` methods now route through the :py:class:`xr.namedarray.parallelcompat.ChunkManagerEntrypoint` (:pull:`9682`). By `Sam Levang `_. .. _whats-new.2024.10.0: @@ -1868,7 +1870,7 @@ Bug fixes Internal Changes ~~~~~~~~~~~~~~~~ - Experimental support for wrapping chunked array libraries other than dask. - A new ABC is defined - :py:class:`xr.core.parallelcompat.ChunkManagerEntrypoint` - which can be subclassed and then + A new ABC is defined - :py:class:`xr.namedarray.parallelcompat.ChunkManagerEntrypoint` - which can be subclassed and then registered by alternative chunked array implementations. (:issue:`6807`, :pull:`7019`) By `Tom Nicholas `_. diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index f41e0eea8cb..4b7a66152f4 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -7072,7 +7072,7 @@ def weighted(self, weights: DataArray) -> DataArrayWeighted: Returns ------- - core.weighted.DataArrayWeighted + computation.weighted.DataArrayWeighted See Also -------- @@ -7117,7 +7117,7 @@ def rolling( Returns ------- - core.rolling.DataArrayRolling + computation.rolling.DataArrayRolling Examples -------- @@ -7157,7 +7157,7 @@ def rolling( -------- DataArray.cumulative Dataset.rolling - core.rolling.DataArrayRolling + computation.rolling.DataArrayRolling """ from xarray.computation.rolling import DataArrayRolling @@ -7183,7 +7183,7 @@ def cumulative( Returns ------- - core.rolling.DataArrayRolling + computation.rolling.DataArrayRolling Examples -------- @@ -7217,7 +7217,7 @@ def cumulative( -------- DataArray.rolling Dataset.cumulative - core.rolling.DataArrayRolling + computation.rolling.DataArrayRolling """ from xarray.computation.rolling import DataArrayRolling @@ -7265,7 +7265,7 @@ def coarsen( Returns ------- - core.rolling.DataArrayCoarsen + computation.rolling.DataArrayCoarsen Examples -------- @@ -7360,7 +7360,7 @@ def coarsen( See Also -------- - :class:`core.rolling.DataArrayCoarsen ` + :class:`computation.rolling.DataArrayCoarsen ` :func:`Dataset.coarsen ` :ref:`reshape.coarsen` diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index bf2858c1b18..faea175e7c0 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -10046,7 +10046,7 @@ def weighted(self, weights: DataArray) -> DatasetWeighted: Returns ------- - core.weighted.DatasetWeighted + computation.weighted.DatasetWeighted See Also -------- @@ -10091,7 +10091,7 @@ def rolling( Returns ------- - core.rolling.DatasetRolling + computation.rolling.DatasetRolling See Also -------- @@ -10123,7 +10123,7 @@ def cumulative( Returns ------- - core.rolling.DatasetRolling + computation.rolling.DatasetRolling See Also -------- @@ -10175,11 +10175,11 @@ def coarsen( Returns ------- - core.rolling.DatasetCoarsen + computation.rolling.DatasetCoarsen See Also -------- - :class:`core.rolling.DatasetCoarsen` + :class:`computation.rolling.DatasetCoarsen` :func:`DataArray.coarsen ` :ref:`reshape.coarsen`