Skip to content

Commit

Permalink
update dataset.merge docs
Browse files Browse the repository at this point in the history
and fix Raises ValueError -> MergeError
  • Loading branch information
jcmgray committed Sep 14, 2016
1 parent c875b24 commit 36cfa76
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions xarray/core/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -1422,7 +1422,8 @@ def merge(self, other, inplace=False, overwrite_vars=set(),
overwrite_vars : str or sequence, optional
If provided, update variables of these name(s) without checking for
conflicts in this dataset.
compat : {'broadcast_equals', 'equals', 'identical'}, optional
compat : {'broadcast_equals', 'equals', 'identical',
'no_conflicts'}, optional
String indicating how to compare variables of the same name for
potential conflicts:
Expand All @@ -1431,6 +1432,9 @@ def merge(self, other, inplace=False, overwrite_vars=set(),
- 'equals': all values and dimensions must be the same.
- 'identical': all values, dimensions and attributes must be the
same.
- 'no_conflicts': only values which are not null in both datasets
must be equal. The returned dataset then contains the combination
of all non-null values.
join : {'outer', 'inner', 'left', 'right'}, optional
Method for joining ``self`` and ``other`` along shared dimensions:
Expand All @@ -1446,7 +1450,7 @@ def merge(self, other, inplace=False, overwrite_vars=set(),
Raises
------
ValueError
MergeError
If any variables conflict (see ``compat``).
"""
variables, coord_names, dims = dataset_merge_method(
Expand Down

0 comments on commit 36cfa76

Please sign in to comment.