docstring replace cores with max_workers

pyiron · Nov 11, 2023 · c1683f3 · c1683f3
1 parent 816b586
commit c1683f3
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/pympipool/flux/executor.py b/pympipool/flux/executor.py
@@ -43,7 +43,7 @@ class PyFluxExecutor(ExecutorBase):
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with PyFluxExecutor(cores=2, init_function=init_k) as p:
+        >>> with PyFluxExecutor(max_workers=2, init_function=init_k) as p:
         >>>     fs = p.submit(calc, 2, j=4)
         >>>     print(fs.result())
         [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]

diff --git a/pympipool/mpi/executor.py b/pympipool/mpi/executor.py
@@ -38,7 +38,7 @@ class PyMPIExecutor(ExecutorBase):
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with PyMPIExecutor(cores=2, init_function=init_k) as p:
+        >>> with PyMPIExecutor(max_workers=2, init_function=init_k) as p:
         >>>     fs = p.submit(calc, 2, j=4)
         >>>     print(fs.result())
         [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]

diff --git a/pympipool/slurm/executor.py b/pympipool/slurm/executor.py
@@ -39,7 +39,7 @@ class PySlurmExecutor(ExecutorBase):
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with PySlurmExecutor(cores=2, init_function=init_k) as p:
+        >>> with PySlurmExecutor(max_workers=2, init_function=init_k) as p:
         >>>     fs = p.submit(calc, 2, j=4)
         >>>     print(fs.result())