documentaiton updates

ContextLab · Jul 27, 2018 · 8e026c4 · 8e026c4
1 parent 86171ef
commit 8e026c4
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/docs/auto_examples/auto_examples_jupyter.zip b/docs/auto_examples/auto_examples_jupyter.zip
diff --git a/docs/auto_examples/auto_examples_python.zip b/docs/auto_examples/auto_examples_python.zip
diff --git a/supereeg/brain.py b/supereeg/brain.py
@@ -237,6 +237,9 @@ def __next__(self):
         return s
 
     def next(self):
+        """
+        Return next sample from Brain object (wrapper for self.__next__)
+        """
         return self.__next__()
 
     def update_filter_inds(self):

diff --git a/supereeg/nifti.py b/supereeg/nifti.py
@@ -213,10 +213,15 @@ def make_gif(self, gifpath, index=range(0, 10), name=None, **kwargs):
 
 
     def get_locs(self):
+        """
+        Return locations of voxels
+        """
         bo = Brain(self)
         return bo.get_locs()
 
 
     def save(self, filepath):
-
+        """
+        Save file to disk
+        """
         self.to_filename(filepath)
diff --git a/supereeg/simulate.py b/supereeg/simulate.py
@@ -137,7 +137,7 @@ def simulate_model_data(n_samples=1000, n_elecs=170, locs=None, sample_locs=None
         Noise added to simulation
 
     set_random_seed : bool or int
-        Default False.  If True, set random seed to 123.  If int, set random seed to value.
+        Default False (choose a random seed).  If True, set random seed to 123.  If int, set random seed to the specified value.
 
     Returns
     ----------