Skip to content

Commit 08a8752

Browse files
committed
Remove docstring in agg_data
1 parent 3fb7003 commit 08a8752

File tree

1 file changed

+0
-35
lines changed

1 file changed

+0
-35
lines changed

nibabel/gifti/gifti.py

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -704,41 +704,6 @@ def agg_data(self, intent_code=None):
704704
-------
705705
tuple of ndarrays or ndarray
706706
If the input is a tuple, the returned tuple will match the order.
707-
708-
Examples
709-
--------
710-
711-
Load two kinds of Gifti files: a surface file containing two types of intent code;
712-
a functional file storing time series data only.
713-
714-
>>> import nibabel as nib
715-
>>> from nibabel.testing import test_data
716-
>>> surf_gii_fname = test_data('gifti', 'ascii.gii')
717-
>>> surf_gii_img = nib.load(surf_gii_fname)
718-
>>> func_gii_fname = test_data('gifti', 'task.func.gii')
719-
>>> func_gii_img = nib.load(func_gii_fname)
720-
721-
When not passing anything to ``intent_code``
722-
723-
>>> surf_gii_img.agg_data() # surface file
724-
>>> func_gii_img.agg_data() # functional file
725-
726-
When passig matching intend codes ``intent_code``
727-
728-
>>> surf_gii_img.agg_data('pointset') # surface pointset
729-
>>> surf_gii_img.agg_data('triangle') # surface triangle
730-
>>> func_gii_img.agg_data('time series') # functional file
731-
732-
When passing mismatching ``intent_code``, the function return a empty ``tuple``
733-
734-
>>> surf_gii_img.agg_data('time series')
735-
>>> func_gii_img.agg_data('triangle')
736-
737-
When passing tuple ``intent_code``, the output will follow
738-
the order of ``intent_code`` in the tuple
739-
740-
>>> surf_gii_img.agg_data(('pointset', 'triangle'))
741-
>>> surf_gii_img.agg_data(('triangle', 'pointset'))
742707
"""
743708

744709
# Allow multiple intents to specify the order

0 commit comments

Comments
 (0)