#3246: Minor edits to documentation following re-review

ESMValGroup · Dec 12, 2023 · e47a70d · e47a70d
1 parent de7397e
commit e47a70d
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/workflow.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/workflow.rst
@@ -24,8 +24,9 @@ The |RTW| performs the following steps:
      or gets the latest container image from DockerHub and converts to a singularity
      image, depending on ``SITE``.
   :Runs on:
-     ``COMPUTE``, which depends on the ``SITE``; at the Met Office, the
-     ``process`` jobs will run on SPICE
+     Localhost (if cloning), or ``COMPUTE`` (if getting container), which
+     depends on the ``SITE``; on JASMIN, the ``get_esmval`` jobs will run on
+     LOTUS
   :Executes:
      The ``clone_latest_esmval.sh`` script (if cloning), or a ``singularity build``
      command (if getting container) from the |Rose| app

diff --git a/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/meta/rose-meta.conf b/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/meta/rose-meta.conf
@@ -81,8 +81,8 @@ type=quoted
 
 [template variables=ENV_NAME]
 compulsory=false
-description=The name of the module to load to setup the environment for the
-           =RTW.
+description=The name of the environment (module or container label) to load for
+           =the RTW.
 help=If required, this value must be set in a site-specific configuration file
     =located in the 'opt/' directory. Otherwise, set the value equal to an
     =empty string.

diff --git a/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/site/jasmin-env b/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/site/jasmin-env
@@ -3,7 +3,7 @@
 # USAGE jasmin-env COMMAND
 #
 # ENVIRONMENT
-#   ENV_NAME         The name of the container being used
+#   ENV_NAME            The name of the container being used
 #   QUIET_MODE          Don't print confirmation messages
 #   PYTHONPATH_PREPEND  The path to prepend to PYTHONPATH
 #

diff --git a/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/site/metoffice-env b/esmvaltool/utils/recipe_test_workflow/recipe_test_workflow/site/metoffice-env
@@ -3,7 +3,7 @@
 # USAGE metoffice-env COMMAND
 #
 # ENVIRONMENT
-#   ENV_NAME         The name of the module to load
+#   ENV_NAME            The name of the module to load
 #   PYTHONPATH_PREPEND  The path to prepend to PYTHONPATH after loading the
 #                       module
 #   QUIET_MODE          Don't print confirmation messages