fix #477 : use raw docstrings (to avoid having to escape \)

Author: alixdamman

larray/core/array.py

@@ -17,7 +17,7 @@
 
 
 def _slice_to_str(key, repr_func=str):
-    """
+    r"""
     Converts a slice to a string
 
     Examples
@@ -41,7 +41,7 @@ def _slice_to_str(key, repr_func=str):
 
 
 def irange(start, stop, step=None):
-    """Create a range, with inclusive stop bound and automatic sign for step.
+    r"""Create a range, with inclusive stop bound and automatic sign for step.
 
     Parameters
     ----------
@@ -82,7 +82,7 @@ def irange(start, stop, step=None):
 
 
 def generalized_range(start, stop, step=1):
-    """Create a range, with inclusive stop bound and automatic sign for step. Bounds can be strings.
+    r"""Create a range, with inclusive stop bound and automatic sign for step. Bounds can be strings.
 
     Parameters
     ----------
@@ -200,7 +200,7 @@ def generalized_range(start, stop, step=1):
 
 
 def _range_str_to_range(s, stack_depth=1):
-    """
+    r"""
     Converts a range string to a range (of values).
     The end point is included.
 
@@ -248,7 +248,7 @@ def _range_str_to_range(s, stack_depth=1):
 
 
 def _range_to_slice(seq, length=None):
-    """
+    r"""
     Returns a slice if possible (including for sequences of 1 element) otherwise returns the input sequence itself
 
     Parameters
@@ -332,7 +332,7 @@ def _seq_group_to_name(seq):
 
 
 def _to_tick(v):
-    """
+    r"""
     Converts any value to a tick (ie makes it hashable, and acceptable as an ndarray element)
 
     scalar -> not modified
@@ -375,7 +375,7 @@ def _to_tick(v):
 
 # TODO: remove the conversion to list in doctests once Python 2 is dropped
 def _to_ticks(s, parse_single_int=False):
-    """
+    r"""
     Makes a (list of) value(s) usable as the collection of labels for an Axis (ie hashable).
 
     Strip strings, split them on ',' and translate "range strings" to list of values **including the end point** !
@@ -439,7 +439,7 @@ def _to_ticks(s, parse_single_int=False):
 
 
 def _seq_str_to_seq(s, stack_depth=1, parse_single_int=False):
-    """
+    r"""
     Converts a sequence string to its sequence (or scalar)
 
     Parameters
@@ -482,7 +482,7 @@ def to_seq(b, stack_depth=1):
 
 
 def _to_key(v, stack_depth=1, parse_single_int=False):
-    """
+    r"""
     Converts a value to a key usable for indexing (slice object, list of values,...).
     Strings are split on ',' and stripped. Colons (:) are interpreted as slices.
 
@@ -585,7 +585,7 @@ def _to_key(v, stack_depth=1, parse_single_int=False):
 
 
 def _to_keys(value, stack_depth=1):
-    """
+    r"""
     Converts a (collection of) group(s) to a structure usable for indexing.
 
     'label' or ['l1', 'l2'] or [['l1', 'l2'], ['l3']]
@@ -670,7 +670,7 @@ def _translate_group_key_hdf(key):
 
 def union(*args):
     # TODO: add support for LGroup and lists
-    """
+    r"""
     Returns the union of several "value strings" as a list.
 
     Parameters
@@ -694,7 +694,7 @@ def union(*args):
 
 
 class IGroupMaker(object):
-    """
+    r"""
     Generates a new instance of IGroup for a given axis and key.
 
     Attributes
@@ -717,8 +717,7 @@ def __getitem__(self, key):
 # We need a separate class for LGroup and cannot simply create a new Axis with a subset of values/ticks/labels:
 # the subset of ticks/labels of the LGroup need to correspond to its *Axis* indices
 class Group(object):
-    """Abstract Group.
-    """
+    r"""Abstract Group. """
     format_string = None
 
     def __init__(self, key, name=None, axis=None):
@@ -777,7 +776,7 @@ def __str__(self):
 
     # TODO: rename to "to_positional"
     def translate(self, bound=None, stop=False):
-        """
+        r"""
         Translate key to a position if it is not already
 
         Parameters
@@ -792,7 +791,7 @@ def translate(self, bound=None, stop=False):
         raise NotImplementedError()
 
     def eval(self):
-        """
+        r"""
         Translate key to labels, if it is not already, expanding slices in the process.
 
         Returns
@@ -802,7 +801,7 @@ def eval(self):
         raise NotImplementedError()
 
     def to_label(self):
-        """
+        r"""
         Translate key to labels, if it is not already
 
         Returns
@@ -812,7 +811,7 @@ def to_label(self):
         raise NotImplementedError()
 
     def retarget_to(self, target_axis):
-        """Retarget group to another axis.
+        r"""Retarget group to another axis.
 
         It will be translated to an LGroup using its former axis, if necessary.
 
@@ -867,7 +866,7 @@ def __iter__(self):
         return iter([LGroup(v, axis=self.axis) for v in self.eval()])
 
     def named(self, name):
-        """Returns group with a different name.
+        r"""Returns group with a different name.
 
         Parameters
         ----------
@@ -882,7 +881,7 @@ def named(self, name):
     __rshift__ = named
 
     def with_axis(self, axis):
-        """Returns group with a different axis.
+        r"""Returns group with a different axis.
 
         Parameters
         ----------
@@ -896,7 +895,7 @@ def with_axis(self, axis):
         return self.__class__(self.key, self.name, axis)
 
     def by(self, length, step=None, template=None):
-        """Split group into several groups of specified length.
+        r"""Split group into several groups of specified length.
 
         Parameters
         ----------
@@ -954,7 +953,7 @@ def make_group(start, length, name_template):
     # IGroup.i[] => IGroup
     # LGroup.i[] => IGroup
     def __getitem__(self, key):
-        """
+        r"""
 
         Parameters
         ----------
@@ -1073,7 +1072,7 @@ def opmethod(self, other):
     __eq__ = _binop('eq')
 
     def equals(self, other):
-        """
+        r"""
         Checks if this group is equal to another group.
         Two groups are equal if they have the same group and axis names and correspond to the same labels.
 
@@ -1136,7 +1135,7 @@ def equals(self, other):
         return res if isinstance(res, bool) else all(res)
 
     def set(self):
-        """Creates LSet from this group
+        r"""Creates LSet from this group
 
         Returns
         -------
@@ -1145,7 +1144,7 @@ def set(self):
         return LSet(self.eval(), self.name, self.axis)
 
     def union(self, other):
-        """Returns (set) union of this label group and other.
+        r"""Returns (set) union of this label group and other.
 
         Labels relative order will be kept intact, but only unique labels will be returned. Labels from this group will
         be before labels from other.
@@ -1173,7 +1172,7 @@ def union(self, other):
         return self.set().union(other)
 
     def intersection(self, other):
-        """Returns (set) intersection of this label group and other.
+        r"""Returns (set) intersection of this label group and other.
 
         In other words, this will return labels from this group which are also in other. Labels relative order will be
         kept intact, but only unique labels will be returned.
@@ -1201,7 +1200,7 @@ def intersection(self, other):
         return self.set().intersection(other)
 
     def difference(self, other):
-        """Returns (set) difference of this label group and other.
+        r"""Returns (set) difference of this label group and other.
 
         In other words, this will return labels from this group without those in other. Labels relative order will be
         kept intact, but only unique labels will be returned.
@@ -1234,7 +1233,7 @@ def __contains__(self, item):
         return item in self.eval()
 
     def startingwith(self, prefix):
-        """
+        r"""
         Returns a group with the labels starting with the specified string.
 
         Parameters
@@ -1262,7 +1261,7 @@ def startingwith(self, prefix):
         return LGroup([v for v in self.eval() if v.startswith(prefix)], axis=self.axis)
 
     def endingwith(self, suffix):
-        """
+        r"""
         Returns a group with the labels ending with the specified string.
 
         Parameters
@@ -1290,7 +1289,7 @@ def endingwith(self, suffix):
         return LGroup([v for v in self.eval() if v.endswith(suffix)], axis=self.axis)
 
     def matching(self, deprecated=None, pattern=None, regex=None):
-        """
+        r"""
         Returns a group with all the labels matching the specified pattern or regular expression.
 
         Parameters
@@ -1359,7 +1358,7 @@ def matching(self, deprecated=None, pattern=None, regex=None):
         return LGroup([v for v in self.eval() if match(v)], axis=self.axis)
 
     def containing(self, substring):
-        """
+        r"""
         Returns a group with all the labels containing the specified substring.
 
         Parameters
@@ -1387,7 +1386,7 @@ def containing(self, substring):
         return LGroup([v for v in self.eval() if substring in v], axis=self.axis)
 
     def to_hdf(self, filepath, key=None, axis_key=None):
-        """
+        r"""
         Writes group to a HDF file.
 
         A HDF file can contain multiple groups.
@@ -1526,7 +1525,7 @@ def remove_nested_groups(key):
 
 
 class LGroup(Group):
-    """Label group.
+    r"""Label group.
 
     Represents a subset of labels of an axis.
 
@@ -1558,7 +1557,7 @@ def __init__(self, key, name=None, axis=None):
 
     # XXX: return IGroup instead?
     def translate(self, bound=None, stop=False):
-        """
+        r"""
         compute position(s) of group
         """
         if bound is None:
@@ -1586,7 +1585,7 @@ def eval(self):
 
 
 class LSet(LGroup):
-    """Label set.
+    r"""Label set.
 
     Represents a set of (unique) labels of an axis.
 
@@ -1657,7 +1656,7 @@ def opmethod(self, other):
 
 
 class IGroup(Group):
-    """Index Group.
+    r"""Index Group.
 
     Represents a subset of indices of an axis.
 
@@ -1674,7 +1673,7 @@ class IGroup(Group):
     format_string = "{axis}.i[{key}]"
 
     def translate(self, bound=None, stop=False):
-        """
+        r"""
         compute position(s) of group
         """
         if bound is not None:

larray/core/axis.py

@@ -110,7 +110,7 @@ def __repr__(self):
 
 
 class Metadata(AttributeDict):
-    """
+    r"""
     An ordered dictionary allowing key-values accessibly using attribute notation (AttributeDict.attribute)
     instead of key notation (Dict["key"]).