Skip to content

Commit

Permalink
Fix docstrings for combine_by_coords (#8471)
Browse files Browse the repository at this point in the history
* Fix docstrings for combine_by_coords

Update default for `combine_attrs` parameter.

* add whats-new

---------

Co-authored-by: Michael Niklas <mick.niklas@gmail.com>
  • Loading branch information
gtrevisan and headtr1ck committed Dec 2, 2023
1 parent 2f00913 commit 1acdb5e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion doc/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,11 @@ Documentation
This is the recommended technique to replace the use of the deprecated ``loffset`` parameter
in ``resample`` (:pull:`8479`).
By `Doug Latornell <https://github.com/douglatornell>`_.

- Improved error message when attempting to get a variable which doesn't exist from a Dataset.
(:pull:`8474`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Fix default value of ``combine_attrs `` in :py:func:`xarray.combine_by_coords` (:pull:`8471`)
By `Gregorio L. Trevisan <https://github.com/gtrevisan>`_.
Internal Changes
~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion xarray/core/combine.py
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ def combine_by_coords(
dimension must have the same size in all objects.
combine_attrs : {"drop", "identical", "no_conflicts", "drop_conflicts", \
"override"} or callable, default: "drop"
"override"} or callable, default: "no_conflicts"
A callable or a string indicating how to combine attrs of the objects being
merged:
Expand Down

0 comments on commit 1acdb5e

Please sign in to comment.