fix docstrings

pyiron · Feb 2, 2025 · acf4693 · acf4693
1 parent 814c0d2
commit acf4693
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/executorlib/interfaces/flux.py b/executorlib/interfaces/flux.py
@@ -82,7 +82,7 @@ class FluxJobExecutor:
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with FluxJobExecutor(cores=2, init_function=init_k) as p:
+        >>> with FluxJobExecutor(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)]
@@ -280,7 +280,7 @@ class FluxClusterExecutor:
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with Executor(cores=2, init_function=init_k) as p:
+        >>> with FluxClusterExecutor(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/executorlib/interfaces/single.py b/executorlib/interfaces/single.py
@@ -59,7 +59,7 @@ class SingleNodeExecutor:
     Examples:
         ```
         >>> import numpy as np
-        >>> from executorlib.interfaces.local import SingleNodeExecutor
+        >>> from executorlib.interfaces.single import SingleNodeExecutor
         >>>
         >>> def calc(i, j, k):
         >>>     from mpi4py import MPI
@@ -70,7 +70,7 @@ class SingleNodeExecutor:
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with SingleNodeExecutor(cores=2, init_function=init_k) as p:
+        >>> with SingleNodeExecutor(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/executorlib/interfaces/slurm.py b/executorlib/interfaces/slurm.py
@@ -72,7 +72,7 @@ class SlurmClusterExecutor:
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with SlurmClusterExecutor(cores=2, init_function=init_k) as p:
+        >>> with SlurmClusterExecutor(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)]
@@ -259,7 +259,7 @@ class SlurmJobExecutor:
         >>> def init_k():
         >>>     return {"k": 3}
         >>>
-        >>> with SlurmJobExecutor(cores=2, init_function=init_k) as p:
+        >>> with SlurmJobExecutor(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)]