Merge pull request #1462 from BRAINSia/doc_reconall

DOC: Adds documentation to create_reconall_workflow

Author: satra

examples/smri_fsreconall.py

@@ -5,11 +5,14 @@
 ================
 
 This script, smri_fsreconall.py, demonstrates the ability to use the
-reconall nipype workflow with a set of subjects and then make an average
-subject::
+create_reconall_workflow function to create a workflow and then run it on a
+set of subjects and then make an average subject::
 
     python smri_fsreconall.py
 
+For an example on how to call FreeSurfer's reconall script in Nipype
+see smri_freesurfer.py.
+
 Import necessary modules from nipype.
 """
 

nipype/workflows/smri/freesurfer/recon.py

@@ -81,7 +81,11 @@ def link_masks(subjects_dir, subject_id):
     return wf
 
 def create_reconall_workflow(name="ReconAll", plugin_args=None):
-    """Creates the ReconAll workflow in nipype.
+    """Creates the ReconAll workflow in Nipype. This workflow is designed to
+    run the same commands as FreeSurfer's reconall script but with the added
+    features that a Nipype workflow provides. Before running this workflow, it
+    is necessary to have the FREESURFER_HOME environmental variable set to the
+    directory containing the version of FreeSurfer to be used in this workflow.
 
     Example
     -------