Merge pull request #221 from pyiron/mini_docs

Small fixes to docstrings
pyiron · Nov 11, 2023 · 816b586 · 816b586
2 parents b75dc1b + 7e6f40c
commit 816b586
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .DS_Store
 .coverage
 .idea/
+.vscode/
diff --git a/pympipool/flux/executor.py b/pympipool/flux/executor.py
@@ -30,7 +30,7 @@ class PyFluxExecutor(ExecutorBase):
         executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
 
     Examples:
-        ```
+
         >>> import numpy as np
         >>> from pympipool.flux import PyFluxExecutor
         >>>
@@ -46,9 +46,8 @@ class PyFluxExecutor(ExecutorBase):
         >>> with PyFluxExecutor(cores=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)]
-        ```
+
     """
 
     def __init__(

diff --git a/pympipool/mpi/executor.py b/pympipool/mpi/executor.py
@@ -25,7 +25,7 @@ class PyMPIExecutor(ExecutorBase):
         sleep_interval (float): synchronization interval - default 0.1
 
     Examples:
-        ```
+
         >>> import numpy as np
         >>> from pympipool.mpi import PyMPIExecutor
         >>>
@@ -42,7 +42,7 @@ class PyMPIExecutor(ExecutorBase):
         >>>     fs = p.submit(calc, 2, j=4)
         >>>     print(fs.result())
         [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]
-        ```
+
     """
 
     def __init__(

diff --git a/pympipool/slurm/executor.py b/pympipool/slurm/executor.py
@@ -26,7 +26,7 @@ class PySlurmExecutor(ExecutorBase):
         sleep_interval (float): synchronization interval - default 0.1
 
     Examples:
-        ```
+
         >>> import numpy as np
         >>> from pympipool.slurm import PySlurmExecutor
         >>>
@@ -44,7 +44,6 @@ class PySlurmExecutor(ExecutorBase):
         >>>     print(fs.result())
 
         [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]
-        ```
     """
 
     def __init__(