Skip to content

Commit a8c49e7

Browse files
committed
[property] Update merge docstring
1 parent 46849aa commit a8c49e7

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

odml/property.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -435,15 +435,16 @@ def merge_check(self, source, strict=True):
435435

436436
def merge(self, other, strict=True):
437437
"""
438-
Merges the property 'other' into self, if possible. Information
439-
will be synchronized. Method will raise a ValueError when the
440-
information in this property and the passed property are in
441-
conflict.
438+
Merges the Property 'other' into self, if possible. Information
439+
will be synchronized. By default the method will raise a ValueError when the
440+
information in this property and the passed property are in conflict.
442441
443442
:param other: an odML Property.
444443
:param strict: Bool value to indicate whether types should be implicitly converted
445444
even when information may be lost. Default is True, i.e. no conversion,
446-
and a ValueError will be raised if types do not match.
445+
and a ValueError will be raised if types or other attributes do not match.
446+
If a conflict arises with strict=False, the attribute value of self will
447+
be kept, while the attribute value of other will be lost.
447448
"""
448449
if not isinstance(other, BaseProperty):
449450
raise TypeError("odml.Property.merge: odml Property required.")

0 commit comments

Comments
 (0)