issues: 785233324

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
785233324 MDU6SXNzdWU3ODUyMzMzMjQ= 4803 Update Documentation for backend Implementation 35919497 closed 0     1 2021-01-13T16:04:47Z 2021-03-08T20:58:02Z 2021-03-08T20:58:02Z COLLABORATOR      

The backend read-support refactor is drawing to a close and we should start to add the documentation to explain how to implement new backends.

We should: - decide where to put the documentation - decide a title - define a brief list of the main points to discuss in the documentation.

For the first point, I suggest putting the documentation in "Internal". For the second one, I suggest: "How to add a new backend"

Concerning the third point, in the following there is a list of the topics, that I suggest:: - BackendEntrypoint Description (BackendEntrypoint is the main interface with xarray, it's a container of functions to be implemented and attributes: guess_can_open, open_dataset, open_dataset_parameters, [guess_can_write], [dataset_writer]) - How to add the backend as an external entrypoint. - Description of the function contained in BackendEntrypoint to be implemented. In particular, for open_dataset we have two option to describe:
- No Lazy it returns a dataset containing numpy arrays. - Lazy it returns a dataset containing BackendArrays: - BackendArrays description: - thread-safe __getitem__ - Pickable (use CachingFileManager) - indexing.IndexingSupport

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/4803/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   completed 13221727 issue

Links from other tables