Make from_product and from_concat docstrings clearer.

neurokernel · Dec 4, 2015 · 7d3cc3f · 7d3cc3f
1 parent 6f0d598
commit 7d3cc3f
Showing 1 changed file with 13 additions and 5 deletions.
diff --git a/neurokernel/pattern.py b/neurokernel/pattern.py
@@ -1313,10 +1313,15 @@ def from_product(cls, *selectors, **kwargs):
             pattern. These selectors must be disjoint, i.e., no identifier comprised
             by one selector may be in any other selector.   
         from_sel, to_sel : str
-            Selectors that describe the pattern's initial index.
+            Selectors that describe the pattern's initial index. If specified,
+            both selectors must be set; the 'io' attribute of the ports
+            comprised by these selectors is respectively set to 'out' and
+            'in'. If no selectors are set, the index is initially empty.
         gpot_sel, spike_sel : str
             Selectors that describe the graded potential and spiking ports in a 
-            pattern's initial index.
+            pattern's initial index. If specified, the 'type' attribute of the
+            ports comprised by these selectors is respectively set to 'gpot'
+            and 'spike'. 
         data : numpy.ndarray, dict, or pandas.DataFrame
             Data to load store in class instance.
         columns : sequence of str
@@ -1428,11 +1433,14 @@ def from_concat(cls, *selectors, **kwargs):
             Data to load store in class instance.
         from_sel, to_sel : str
             Selectors that describe the pattern's initial index. If specified,
-            both selectors must be set. If no selectors are set, the index is
-            initially empty.
+            both selectors must be set; the 'io' attribute of the ports
+            comprised by these selectors is respectively set to 'out' and
+            'in'. If no selectors are set, the index is initially empty.
         gpot_sel, spike_sel : str
             Selectors that describe the graded potential and spiking ports in a 
-            pattern's initial index.
+            pattern's initial index. If specified, the 'type' attribute of the
+            ports comprised by these selectors is respectively set to 'gpot'
+            and 'spike'. 
         columns : sequence of str
             Data column names.
         validate : bool