Skip to content

Commit

Permalink
Add note on DataTree.map_over_datasets to migration guide (#9804)
Browse files Browse the repository at this point in the history
* new blank whatsnew

* add note on map_over_subtree -> map_over_datasets
  • Loading branch information
TomNicholas authored Nov 22, 2024
1 parent 1c88f1e commit 38d5308
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions DATATREE_MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ A number of other API changes have been made, which should only require minor mo
- The `DataTree.parent` property is now read-only. To assign a ancestral relationships directly you must instead use the `.children` property on the parent node, which remains settable.
- Similarly the `parent` kwarg has been removed from the `DataTree.__init__` constructor.
- DataTree objects passed to the `children` kwarg in `DataTree.__init__` are now shallow-copied.
- `DataTree.map_over_subtree` has been renamed to `DataTree.map_over_datasets`, and changed to no longer work like a decorator. Instead you use it to apply the function and arguments directly, more like how `xarray.apply_ufunc` works.
- `DataTree.as_array` has been replaced by `DataTree.to_dataarray`.
- A number of methods which were not well tested have been (temporarily) disabled. In general we have tried to only keep things that are known to work, with the plan to increase API surface incrementally after release.

Expand Down

0 comments on commit 38d5308

Please sign in to comment.