Revert "Remove the actual docstring to prevent errors"

This reverts commit 384475b.

Author: htwangtw

nibabel/gifti/tests/test_gifti.py

@@ -25,7 +25,42 @@
 
 def test_agg_data():
     """
-    Move examples of aggregate GIFTI data arrays into an ndarray or tuple of ndarray
+    Aggregate GIFTI data arrays into an ndarray or tuple of ndarray
+
+    Examples
+    --------
+
+    Load two kinds of Gifti files: a surface file containing two types of intent code;
+    a functional file storing time series data only.
+
+    >>> import nibabel as nib
+    >>> from nibabel.testing import test_data
+    >>> surf_gii_fname = test_data('gifti', 'ascii.gii')
+    >>> surf_gii_img = nib.load(surf_gii_fname)
+    >>> func_gii_fname = test_data('gifti', 'task.func.gii')
+    >>> func_gii_img = nib.load(func_gii_fname)
+
+    When not passing anything to ``intent_code``
+
+    >>> surf_gii_img.agg_data()  # surface file
+    >>> func_gii_img.agg_data()  # functional file
+
+    When passig matching intend codes ``intent_code``
+
+    >>> surf_gii_img.agg_data('pointset')  # surface pointset
+    >>> surf_gii_img.agg_data('triangle')  # surface triangle
+    >>> func_gii_img.agg_data('time series')  # functional file
+
+    When passing mismatching ``intent_code``, the function return a empty ``tuple``
+
+    >>> surf_gii_img.agg_data('time series')
+    >>> func_gii_img.agg_data('triangle')
+
+    When passing tuple ``intent_code``, the output will follow
+    the order of ``intent_code`` in the tuple
+
+    >>> surf_gii_img.agg_data(('pointset', 'triangle'))
+    >>> surf_gii_img.agg_data(('triangle', 'pointset'))
     """
 
     surf_gii_fname = test_data('gifti', 'ascii.gii')
@@ -38,21 +73,15 @@ def test_agg_data():
     func_da = func_gii_img.get_arrays_from_intent('time series')
     func_data = np.column_stack(tuple(da.data for da in func_da))
 
-    # When not passing anything to ``intent_code``
     assert_equal(surf_gii_img.agg_data(), (point_data, triangle_data))  # surface file
     assert_array_equal(func_gii_img.agg_data(), func_data)  # functional 
-
-    # When passig matching intend codes ``intent_code``
     assert_array_equal(surf_gii_img.agg_data('pointset'), point_data)  # surface pointset
     assert_array_equal(surf_gii_img.agg_data('triangle'), triangle_data)  # surface triangle
     assert_array_equal(func_gii_img.agg_data('time series'), func_data)  # functional 
 
-    # When passing mismatching ``intent_code``, the function return a empty ``tuple``
     assert_equal(surf_gii_img.agg_data('time series'), ())
     assert_equal(func_gii_img.agg_data('triangle'), ())
 
-    # When passing tuple ``intent_code``, the output will follow
-    # the order of ``intent_code`` in the tuple
     assert_equal(surf_gii_img.agg_data(('pointset', 'triangle')), (point_data, triangle_data))
     assert_equal(surf_gii_img.agg_data(('triangle', 'pointset')), (triangle_data, point_data))