Skip to content

Commit b5a84ba

Browse files
committed
fix more links and move BackendEntrypoint to the advanced API [skip-ci]
1 parent 6c6929f commit b5a84ba

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

doc/api-hidden.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -826,10 +826,9 @@
826826
backends.DummyFileManager.acquire_context
827827
backends.DummyFileManager.close
828828

829-
backends.common.BackendArray
830-
backends.common.BackendEntrypoint
831-
backends.common.BackendEntrypoint.guess_can_open
832-
backends.common.BackendEntrypoint.open_dataset
829+
backends.BackendArray
830+
backends.BackendEntrypoint.guess_can_open
831+
backends.BackendEntrypoint.open_dataset
833832

834833
core.indexing.IndexingSupport
835834
core.indexing.explicit_indexing_adapter

doc/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -890,6 +890,8 @@ Advanced API
890890
as_variable
891891
register_dataset_accessor
892892
register_dataarray_accessor
893+
backends.BackendArray
894+
backends.BackendEntrypoint
893895

894896
These backends provide a low-level interface for lazily loading data from
895897
external file-formats or protocols, and can be manually invoked to create

doc/internals/how-to-add-new-backend.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ How to add a new backend
66
Adding a new backend for read support to Xarray does not require
77
to integrate any code in Xarray; all you need to do is:
88

9-
- Create a class that inherits from Xarray :py:class:`~xarray.backends.common.BackendEntrypoint`
9+
- Create a class that inherits from Xarray :py:class:`~xarray.backends.BackendEntrypoint`
1010
and implements the method ``open_dataset`` see :ref:`RST backend_entrypoint`
1111

1212
- Declare this class as an external plugin in your ``setup.py``, see :ref:`RST backend_registration`
@@ -161,8 +161,8 @@ guess_can_open
161161
``guess_can_open`` is used to identify the proper engine to open your data
162162
file automatically in case the engine is not specified explicitly. If you are
163163
not interested in supporting this feature, you can skip this step since
164-
:py:class:`~xarray.backends.common.BackendEntrypoint` already provides a
165-
default :py:meth:`~xarray.backend.common.BackendEntrypoint.guess_can_open`
164+
:py:class:`~xarray.backends.BackendEntrypoint` already provides a
165+
default :py:meth:`~xarray.backends.BackendEntrypoint.guess_can_open`
166166
that always returns ``False``.
167167

168168
Backend ``guess_can_open`` takes as input the ``filename_or_obj`` parameter of
@@ -299,7 +299,7 @@ Where:
299299
- :py:class:`~xarray.core.indexing.LazilyIndexedArray` is a class
300300
provided by Xarray that manages the lazy loading.
301301
- ``MyBackendArray`` shall be implemented by the backend and shall inherit
302-
from :py:class:`~xarray.backends.common.BackendArray`.
302+
from :py:class:`~xarray.backends.BackendArray`.
303303

304304
BackendArray subclassing
305305
^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)