docs: CommonSettings (#50)

Author: jakevc

README.md

@@ -60,7 +60,10 @@ common_settings = CommonSettings(
     # plugins (snakemake-executor-plugin-dryrun, snakemake-executor-plugin-local)
     # are expected to specify False here.
     non_local_exec=True,
+    # Whether the executor implies to not have a shared file system
     implies_no_shared_fs=True,
+    # whether to deploy workflow sources to default storage provider before execution
+    job_deploy_sources=True,
     # whether arguments for setting the storage provider shall be passed to jobs
     pass_default_storage_provider_args=True,
     # whether arguments for setting default resources shall be passed to jobs

snakemake_interface_executor_plugins/settings.py

@@ -20,10 +20,10 @@ class CommonSettings:
     ----------
     non_local_exec : bool
         Whether to execute jobs locally or on a cluster.
-    force_no_shared_fs : bool
-        Whether to the executor implies to not have a shared file system.
+    implies_no_shared_fs : bool
+        Whether the executor implies to not have a shared file system.
     dryrun_exec : bool
-        Whether to jobs will be executed in dry-run mode.
+        Whether jobs will be executed in dry-run mode.
     job_deploy_sources : bool
         Whether to deploy workflow sources before job execution. This is e.g.
         needed when remote jobs are guaranteed to be not executed on a shared