Datatree needs some documentation, even if it has to change in future.
I think most of the documentation would remain relevant even after some changes, as long as we keep the same basic data model (e.g. DataTree vs DataGroups, with no hierarchy).
I really like this breakdown for documentation, which theorizes that there are 4 types of documentation, along two axes, as shown in this diagram:
Another thing to consider is how the documentation we write now might eventually be incorporated into xarray's documentation upstream. We don't need to duplicate anything, and we want things we write to neatly slot into sections in xarray's existing documentation.
Some ideas:
Tutorials(Some of these could possibly go in xarray's Gallery section)
(A lot of this could be grouped under one page on "Working with hierarchical data".)
This should be pretty much covered by ensuring that the auto-generated API docs work properly. The hard bit will be copying / duplicating the large API of xarray.Dataset that DataTree inherits.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4
