From bcca62e50a05a366eee69304deb39efdd20cb591 Mon Sep 17 00:00:00 2001
From: Martin Yeo <martin.yeo@metoffice.gov.uk>
Date: Thu, 17 Aug 2023 15:52:34 +0100
Subject: [PATCH] Minor documentation clarifications.

---
 .github/workflows/benchmarks_run.yml |  2 +-
 benchmarks/bm_runner.py              | 13 ++++++++-----
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/benchmarks_run.yml b/.github/workflows/benchmarks_run.yml
index d29e251086..0ea53a423c 100644
--- a/.github/workflows/benchmarks_run.yml
+++ b/.github/workflows/benchmarks_run.yml
@@ -12,7 +12,7 @@ on:
   workflow_dispatch:
     inputs:
       first_commit:
-        description: "Argument to be passed to the overnight benchmark script."
+        description: "First commit to benchmark (see bm_runner.py > Overnight)."
         required: false
         type: string
   pull_request:
diff --git a/benchmarks/bm_runner.py b/benchmarks/bm_runner.py
index bf7b25159d..880f52961c 100644
--- a/benchmarks/bm_runner.py
+++ b/benchmarks/bm_runner.py
@@ -344,7 +344,7 @@ def add_asv_arguments(self) -> None:
         self.subparser.add_argument(
             "asv_args",
             nargs=argparse.REMAINDER,
-            help="Any number of arguments to pass down to ASV.",
+            help="Any number of arguments to pass down to the ASV benchmark command.",
         )
 
     @staticmethod
@@ -364,10 +364,11 @@ class Overnight(_SubParserGenerator):
     name = "overnight"
     description = (
         "Benchmarks all commits between the input **first_commit** to ``HEAD``, "
-        "comparing each to its parent for performance shifts. If running on"
+        "comparing each to its parent for performance shifts. If running on "
         "GitHub Actions: performance shift(s) will be reported in a new issue.\n"
         "Designed for checking the previous 24 hours' commits, typically in a "
-        "scheduled script."
+        "scheduled script.\n"
+        "Uses `asv run`."
     )
     epilog = (
         "e.g. python bm_runner.py overnight a1b23d4\n"
@@ -410,7 +411,8 @@ class Branch(_SubParserGenerator):
         "for testing if the active branch's changes cause performance shifts - "
         "anticipating what would be caught by ``overnight`` once merged.\n\n"
         "**For maximum accuracy, avoid using the machine that is running this "
-        "session. Run time could be >1 hour for the full benchmark suite.**"
+        "session. Run time could be >1 hour for the full benchmark suite.**\n"
+        "Uses `asv run`."
     )
     epilog = (
         "e.g. python bm_runner.py branch upstream/main\n"
@@ -453,7 +455,8 @@ class _CSPerf(_SubParserGenerator, ABC):
         "Run the on-demand {} suite of benchmarks (part of the UK Met "
         "Office NG-VAT project) for the ``HEAD`` of ``upstream/main`` only, "
         "and publish the results to the input **publish_dir**, within a "
-        "unique subdirectory for this run."
+        "unique subdirectory for this run.\n"
+        "Uses `asv run`."
     )
     epilog = (
         "e.g. python bm_runner.py {0} my_publish_dir\n"