From 009320c9fcfc2beb2ed32dd77b5a064f86104bae Mon Sep 17 00:00:00 2001 From: Philip Eisenlohr Date: Tue, 9 Aug 2022 09:29:22 -0400 Subject: [PATCH] polishing of doc-strings --- python/damask/_rotation.py | 6 +++--- python/damask/_table.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/python/damask/_rotation.py b/python/damask/_rotation.py index ac93fe885..229e1324e 100644 --- a/python/damask/_rotation.py +++ b/python/damask/_rotation.py @@ -117,7 +117,7 @@ class Rotation: def __getitem__(self, item: Union[Tuple[int], int, bool, np.bool_, np.ndarray]): """ - Return x[y]. + Return self[item]. Return slice according to item. @@ -376,7 +376,7 @@ class Rotation: """ Return self@other. - Rotate vector, second order tensor, or fourth order tensor. + Rotate vector, second-order tensor, or fourth-order tensor. Parameters ---------- @@ -408,7 +408,7 @@ class Rotation: R = self.as_matrix() return np.einsum('...im,...jn,...ko,...lp,...mnop',R,R,R,R,other) else: - raise ValueError('can only rotate vectors, 2nd order tensors, and 4th order tensors') + raise ValueError('can only rotate vectors, second-order tensors, and fourth-order tensors') elif isinstance(other, Rotation): raise TypeError('use "R1*R2", i.e. multiplication, to compose rotations "R1" and "R2"') else: diff --git a/python/damask/_table.py b/python/damask/_table.py index 94cba9b89..b42c18703 100644 --- a/python/damask/_table.py +++ b/python/damask/_table.py @@ -54,7 +54,7 @@ class Table: """ Return self==other. - Test equality of other table. + Test equality of other. """ return NotImplemented if not isinstance(other,Table) else \ @@ -64,9 +64,9 @@ class Table: def __getitem__(self, item: Union[slice, Tuple[slice, ...]]) -> 'Table': """ - Return x[y]. + Return self[item]. - Return table slice according to item. + Return slice according to item. Parameters ----------