Merge pull request #987 from selmanozleyen/docs/spatial-autocorr

Docs: Edit the argument documentation of `n_jobs` of the `parallelize` function

Author: selmanozleyen

src/squidpy/_docs.py

@@ -107,7 +107,8 @@ def decorator2(obj: Any) -> Any:
 """
 _parallelize = """\
 n_jobs
-    Number of parallel jobs.
+    Number of parallel jobs to use. If the function uses numba compiled functions, numba may
+    use cores depending on the number of threads set in the environment regardless of this argument.
 backend
     Parallelization backend to use. See :class:`joblib.Parallel` for available options.
 show_progress_bar

src/squidpy/_utils.py

@@ -88,7 +88,8 @@ def parallelize(
     collection
         Sequence of items to split into chunks.
     n_jobs
-        Number of parallel jobs.
+        Number of parallel jobs to use. If the function uses numba compiled functions, numba may
+        use cores depending on the number of threads set in the environment regardless of this argument.
     n_split
         Split ``collection`` into ``n_split`` chunks.
         If <= 0, ``collection`` is assumed to be already split into chunks.