DOC: Add new backend page does not mention DataTree

Open Beginner friendly
#10,800 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the “How to add a new backend” page at docs.xarray.dev and compare it with the BackendEntrypoint.open_datatree documentation. Add a note explaining DataTree support and link to the open_datatree documentation; the page should clearly cover this backend capability when complete.

Written by the indexing model from the issue text.

Description

needs triage
What is your issue?

The adding a new backend docs page: https://docs.xarray.dev/en/stable/internals/how-to-add-new-backend.html

does not mention DataTree despire Backends being required to implement:

https://docs.xarray.dev/en/stable/generated/xarray.backends.BackendEntrypoint.html#xarray.backends.BackendEntrypoint

open_datatree method: it shall implement reading from file, variables decoding and it returns an instance of DataTree. It shall take in input at least filename_or_obj argument. The implementation of this method is not mandatory. For more details see .

Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pydata/xarray

All issues in pydata/xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.