Merge branch 'docstring-polishing' into 'development'

increasing consistency

See merge request damask/DAMASK!616
This commit is contained in:
Martin Diehl 2022-08-17 04:41:11 +00:00
commit 31fe894c78
2 changed files with 5 additions and 3 deletions

View File

@ -120,7 +120,7 @@ class Config(dict):
"""
Return self|=other.
Update configuration with contents of other.
Update configuration with contents of other (in-place).
"""
return self.__or__(other)

View File

@ -246,11 +246,13 @@ class Orientation(Rotation,Crystal):
def __mul__(self: MyType,
other: Union[Rotation, 'Orientation']) -> MyType:
"""
Compose this orientation with other.
Return self*other.
Compose with other.
Parameters
----------
other : Rotation or Orientation
other : Rotation or Orientation, shape (self.shape)
Object for composition.
Returns