Skip to content

[Fix] broken docstring for slurm_cmd_args #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jan-janssen merged 1 commit into from
Mar 24, 2026
Merged

[Fix] broken docstring for slurm_cmd_args #955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/executorlib/executor/flux.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class FluxJobExecutor(BaseExecutor):
allowed to take in seconds.
* priority (int): the queuing system priority assigned to a given Python function to
influence the scheduling.
*`slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
* slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None
flux_executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
flux_executor_nesting (bool): Provide hierarchically nested Flux job scheduler inside the submitted function.
Expand Down Expand Up @@ -287,7 +287,7 @@ class FluxClusterExecutor(BaseExecutor):
allowed to take in seconds.
* priority (int): the queuing system priority assigned to a given Python function to
influence the scheduling.
*`slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
* slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
Expand Down Expand Up @@ -544,7 +544,7 @@ def create_flux_executor(
allowed to take in seconds.
* priority (int): the queuing system priority assigned to a given Python function to
influence the scheduling.
*`slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
* slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None
flux_executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
flux_executor_nesting (bool): Provide hierarchically nested Flux job scheduler inside the submitted function.
Expand Down
4 changes: 2 additions & 2 deletions src/executorlib/executor/slurm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class SlurmClusterExecutor(BaseExecutor):
allowed to take in seconds.
* priority (int): the queuing system priority assigned to a given Python function to
influence the scheduling.
*`slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
* slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
Expand Down Expand Up @@ -297,7 +297,7 @@ class SlurmJobExecutor(BaseExecutor):
allowed to take in seconds.
* priority (int): the queuing system priority assigned to a given Python function to
influence the scheduling.
*`slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
* slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
context of an HPC cluster this essential to be able to communicate to an
Expand Down
Loading