Skip to content

Commit

Permalink
explain keep_attrs in docstring of apply_ufunc (#7445)
Browse files Browse the repository at this point in the history
  • Loading branch information
arongergely authored Jan 16, 2023
1 parent b741d83 commit 522ee22
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions xarray/core/computation.py
Original file line number Diff line number Diff line change
Expand Up @@ -938,8 +938,12 @@ def apply_ufunc(
Value used in place of missing variables on Dataset inputs when the
datasets do not share the exact same ``data_vars``. Required if
``dataset_join not in {'inner', 'exact'}``, otherwise ignored.
keep_attrs : bool, optional
Whether to copy attributes from the first argument to the output.
keep_attrs : {"drop", "identical", "no_conflicts", "drop_conflicts", "override"} or bool, optional
- 'drop' or False: empty attrs on returned xarray object.
- 'identical': all attrs must be the same on every object.
- 'no_conflicts': attrs from all objects are combined, any that have the same name must also have the same value.
- 'drop_conflicts': attrs from all objects are combined, any that have the same name but different values are dropped.
- 'override' or True: skip comparing and copy attrs from the first object to the result.
kwargs : dict, optional
Optional keyword arguments passed directly on to call ``func``.
dask : {"forbidden", "allowed", "parallelized"}, default: "forbidden"
Expand Down

0 comments on commit 522ee22

Please sign in to comment.