From c872c531e49efd120a847986432623f83a6d3ece Mon Sep 17 00:00:00 2001 From: abhinav Date: Tue, 11 Aug 2026 15:42:37 +0530 Subject: [PATCH] docs: document return value of run_block_function Add the missing Returns section to the run_block_function docstring. Fixes #155 --- src/brainiak/searchlight/searchlight.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/brainiak/searchlight/searchlight.py b/src/brainiak/searchlight/searchlight.py index d54fcf53..febe9e79 100644 --- a/src/brainiak/searchlight/searchlight.py +++ b/src/brainiak/searchlight/searchlight.py @@ -426,6 +426,15 @@ def run_block_function(self, block_fn, extra_block_fn_params=None, Maximum number of processes running the block function in parallel. If None, number of available hardware threads, considering cpusets restrictions. + + Returns + ------- + + An object array with the same shape as the mask, where each voxel + contains the 3D array returned by the block function for the block + containing that voxel, with the padding removed. The array is + populated only on the root rank; on other ranks it is returned + unpopulated. """ rank = self.comm.rank