docs: update contribution docs

snakemake · Aug 23, 2022 · 09a5595 · 09a5595
1 parent f743e1d
commit 09a5595
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/docs/project_info/contributing.rst b/docs/project_info/contributing.rst
@@ -64,9 +64,6 @@ Below you find a skeleton
                  assume_shared_fs=True,
                  max_status_checks_per_second=1):
 
-            # overwrite the command to execute a single snakemake job if necessary
-            # exec_job = "..."
-
             super().__init__(workflow, dag, None,
                              jobname=jobname,
                              printreason=printreason,
@@ -76,9 +73,8 @@ Below you find a skeleton
                              cluster_config=cluster_config,
                              local_input=local_input,
                              restart_times=restart_times,
-                             exec_job=exec_job,
-                             assume_shared_fs=False,
-                             max_status_checks_per_second=10)
+                             assume_shared_fs=False, # if your executor relies on a shared file system, set this to True
+                             max_status_checks_per_second=max_status_checks_per_second)  # set this to a reasonable default
 
             # add additional attributes
 
@@ -116,7 +112,9 @@ Below you find a skeleton
             """Run an individual job or a job group.
             """
 
+            # Necessary: perform additional executor independent steps before running the job
             super()._run(job)
+            
             # obtain job execution command
             exec_job = self.format_job(
                 self.exec_job, job, _quote_all=True,

diff --git a/snakemake/executors/__init__.py b/snakemake/executors/__init__.py
@@ -687,7 +687,6 @@ def __init__(
         cluster_config=None,
         local_input=None,
         restart_times=None,
-        exec_job=None,
         assume_shared_fs=True,
         max_status_checks_per_second=1,
         disable_default_remote_provider_args=False,