Skip to content

Commit

Permalink
Fix core.mixins docs (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
a5kin committed Jun 11, 2019
1 parent 4ee36e4 commit 9b6732a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions xentica/core/mixins.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

class BscaDetectorMixin:
"""
Add a functionlality to detect BSCA class instances holding current class.
Add a functionality to detect BSCA class instances holding current class.
All methods are for private use only.
Expand All @@ -26,7 +26,8 @@ def bsca(self):
"""
Get a BSCA instance holding current class.
Objects tree is scanned up to top and first instance found is returned.
The objects tree is scanned up to the top and the first
instance found is returned.
"""
frame = inspect.currentframe()
Expand All @@ -42,9 +43,10 @@ def bsca(self):
@property
def _holder_frame(self):
"""
Get a frame of class instance holding current class.
Get a frame of the class instance holding the current class.
Objects tree is scanned up to top and first instance found is returned.
The objects tree is scanned up to the top and the first
instance found is returned.
"""
# As an option, we can detect base class by scanning inheritance tree:
Expand All @@ -64,7 +66,7 @@ class DimensionsMixin:
"""

#: A list of integers, containing supported dimensionality.
#: A list of integers, containing a supported dimensionality.
#: You must set it manually for every class using :class:`DimensionsMixin`.
supported_dimensions = []

Expand All @@ -74,10 +76,10 @@ def __init__(self):

def allowed_dimension(self, num_dim):
"""
Test if particular dimensionality is allowed.
Test if a particular dimensionality is allowed.
:param num_dim:
Numbers of dimensions to test
The number of dimensions to test
:returns:
Boolean value, either dimensionality is allowed or not.
Expand Down

0 comments on commit 9b6732a

Please sign in to comment.