-

cool-RR · cool-RR · commit beec4c6a7fce · 2014-10-19T19:31:53.000+03:00
diff --git a/source_py3/python_toolbox/combi/perming/perm.py b/source_py3/python_toolbox/combi/perming/perm.py
@@ -47,14 +47,7 @@ def __getitem__(self, i):
 
 class PermAsDictoid(sequence_tools.CuteSequenceMixin, _BasePermView,
                     collections.Mapping):
-    '''blocktododoc
-    A viewer of a perm's items, similar to `dict.items()`.
-    
-    This is useful for dapplied perms; it lets you view the perm (both index
-    access and iteration) as a sequence where each item is a 2-tuple, where the
-    first item is from the domain and the second item is its corresponding item
-    from the sequence.
-    '''    
+    '''A dict-like interface to a `Perm`.'''    
     def __getitem__(self, key):
         return self.perm[key]
     def __iter__(self):
@@ -63,6 +56,12 @@ def __iter__(self):
     
 
 class PermType(abc.ABCMeta):
+    '''
+    Metaclass for `Perm` and `Comb`.
+    
+    The functionality provided is: If someone tries to create a `Perm` with a
+    `CombSpace`, we automatically use `Comb`.
+    '''
     def __call__(cls, item, perm_space=None):
         if cls == Perm and isinstance(perm_space, CombSpace):
             cls = Comb
@@ -72,6 +71,11 @@ def __call__(cls, item, perm_space=None):
 @functools.total_ordering
 class Perm(sequence_tools.CuteSequenceMixin, collections.Sequence,
            metaclass=PermType):
+    '''
+    A permutation.
+    
+    
+    '''
     
     @classmethod
     def coerce(cls, item, perm_space=None):
diff --git a/source_py3/python_toolbox/combi/perming/perm_space.py b/source_py3/python_toolbox/combi/perming/perm_space.py
@@ -33,8 +33,7 @@ class PermSpaceType(abc.ABCMeta):
     Metaclass for `PermSpace` and `CombSpace`.
     
     The functionality provided is: If someone tries to instantiate `PermSpace`
-    while specifying `is_combination=True`, we automatically use `CombSpace`
-    for him.
+    while specifying `is_combination=True`, we automatically use `CombSpace`.
     '''
     def __call__(cls, *args, **kwargs):
         if cls == PermSpace and kwargs.get('is_combination', False):
