update kgo instructions (#234)

MetOffice · Aug 14, 2024 · c13813f · c13813f
1 parent 9e831bc
commit c13813f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/source/Reviewers/howtocommit.rst b/source/Reviewers/howtocommit.rst
@@ -477,12 +477,15 @@ for all affected tests before you commit to the trunk.
 
         .. code-block::
 
-            python3 ./rose-stem/bin/update_branch_kgos.py -s <suite name> -w <path to working copy>
+            python3 ./rose-stem/bin/update_branch_kgos.py -s <suite name/runX> -w <path to working copy>
 
         .. note::
               This script requires at least python 3.9. This can be achieved on
               Met Office machines by running ``module load scitools``
 
+        .. note::
+              The numbered run directory must be included in the suite name, eg. `name-of-suite/run1`.
+
 
     .. tab-item:: LFRic Core
 

diff --git a/source/WorkingPractices/kgo.rst b/source/WorkingPractices/kgo.rst
@@ -44,12 +44,15 @@ such changes onto the trunk. When preparing your change for review:
 
            .. code-block::
 
-              python3 ./rose-stem/bin/update_branch_kgos.py -s <suite name> -w <path to working copy>
+              python3 ./rose-stem/bin/update_branch_kgos.py -s <suite name/runX> -w <path to working copy>
 
            .. note::
               This script requires at least python 3.9. This can be achieved on
               Met Office machines by running ``module load scitools``
 
+           .. note::
+              The numbered run directory must be included in the suite name, eg. `name-of-suite/run1`.
+
         4. The changes in answers should be science reviewed by someone familiar with
            the failing tests - if unsure then start with the Code Owner for the affected
            application.