cleanup and better docstrings

Author: gdementen

larray/core/array.py

@@ -2664,8 +2664,8 @@ def _cum_aggregate(self, op, axis):
         return Array(op(np.asarray(self), axis=self.axes.index(axis)),
                      self.axes)
 
-    # TODO: now that items is never a (k, v), it should be renamed to
-    # something else: args? (groups would be misleading because each "item" can contain several groups)
+    # TODO: now that items is never a (k, v), it should be renamed to something else: args?
+    #       (groups would be misleading because each "item" can contain several groups)
     # TODO: experiment implementing this using ufunc.reduceat
     # http://docs.scipy.org/doc/numpy-1.10.0/reference/generated/numpy.ufunc.reduceat.html
     # XXX: rename keepaxes to label=value? For group_aggregates we might want to keep the LGroup label if any

larray/core/axis.py

@@ -578,7 +578,7 @@ def matching(self, deprecated=None, pattern=None, regex=None):
 
         Parameters
         ----------
-        pattern : str or Group
+        pattern : str or Group, optional
             Pattern to match.
             * `?`     matches any single character
             * `*`     matches any number of characters
@@ -587,7 +587,7 @@ def matching(self, deprecated=None, pattern=None, regex=None):
 
             To match any of the special characters above, wrap the character in brackets. For example, `[?]` matches
             the character `?`.
-        regex : str or Group
+        regex : str or Group, optional
             Regular expression pattern to match. Regular expressions are more powerful than what the simple patterns
             supported by the `pattern` argument but are also more complex to write.
             See `Regular Expression <https://docs.python.org/3/library/re.html>`_ for more details about how to build
@@ -3230,7 +3230,7 @@ def split_axes(self, axes=None, sep='_', names=None, regex=None):
         names : str or list of str, optional
             names of resulting axes. Defaults to None.
         regex : str, optional
-            use regex instead of delimiter to split labels. Defaults to None.
+            use the `regex` regular expression to split labels instead of the `sep` delimiter. Defaults to None.
 
         See Also
         --------
@@ -3260,7 +3260,7 @@ def split_axes(self, axes=None, sep='_', names=None, regex=None):
             Axis(['b0', 'b1', 'b2'], 'b')
         ])
 
-        Split labels using regex
+        Split labels using a regular expression
 
         >>> combined = AxisCollection('a_b = a0b0..a1b2')
         >>> combined

larray/core/group.py

@@ -1582,7 +1582,7 @@ def translate(self, bound=None, stop=False):
             bound = self.key
         if isinstance(self.axis, ABCAxis):
             pos = self.axis.index(bound)
-            return pos + int(stop) if np.isscalar(pos) else pos
+            return (pos + int(stop)) if np.isscalar(pos) else pos
         else:
             raise ValueError("Cannot translate an LGroup without axis")