Adding consistency to docstring structure

This commit is contained in:
d.mentock 2022-07-08 18:07:07 +02:00
parent df1f362ed3
commit 3492dfcd3b
6 changed files with 10 additions and 10 deletions

View File

@ -51,7 +51,7 @@ class Colormap(mpl.colors.ListedColormap):
"""
Return self==other.
Test equality of colormaps.
Test equality of other.
"""
if not isinstance(other, Colormap):
@ -104,7 +104,7 @@ class Colormap(mpl.colors.ListedColormap):
"""
Return ~self.
Return reverse of self
Reverse.
"""
return self.reversed()

View File

@ -422,7 +422,7 @@ class Crystal():
"""
Return self==other.
Equal to other.
Test equality of other.
Parameters
----------

View File

@ -152,7 +152,7 @@ class Orientation(Rotation,Crystal):
"""
Return self==other.
Equal to other.
Test equality of other.
Parameters
----------
@ -172,7 +172,7 @@ class Orientation(Rotation,Crystal):
"""
Return self!=other.
Not equal to other.
Test inequality of other.
Parameters
----------

View File

@ -131,7 +131,7 @@ class Rotation:
"""
Return self==other.
Equal to other.
Test equality of other.
Parameters
----------
@ -149,7 +149,7 @@ class Rotation:
"""
Return self!=other.
Not equal to other.
Test inequality of other.
Parameters
----------

View File

@ -54,7 +54,7 @@ class Table:
"""
Return self==other.
Compare to other Table.
Test equality of other table.
"""
return NotImplemented if not isinstance(other,Table) else \
@ -66,7 +66,7 @@ class Table:
"""
Return x[y].
Slice the Table according to item.
Return table slice according to item.
Parameters
----------

View File

@ -61,7 +61,7 @@ class VTK:
"""
Return self==other.
Equal to other.
Test equality of other.
Parameters
----------