From 2379fcbb0016d0ea4c72594d51a81fce8d1931af Mon Sep 17 00:00:00 2001
From: Francois Kritzinger <francois@codesynthesis.com>
Date: Thu, 21 Nov 2024 11:15:35 +0200
Subject: Fix comments and error message

---
 mod/mod-ci-github-gq.cxx | 12 +++++++-----
 mod/mod-ci-github-gq.hxx |  7 ++-----
 2 files changed, 9 insertions(+), 10 deletions(-)

(limited to 'mod')

diff --git a/mod/mod-ci-github-gq.cxx b/mod/mod-ci-github-gq.cxx
index 0868987..b1168ba 100644
--- a/mod/mod-ci-github-gq.cxx
+++ b/mod/mod-ci-github-gq.cxx
@@ -219,9 +219,11 @@ namespace brep
     return r;
   }
 
-  // Send a GraphQL mutation request `rq` that operates on one or more check
-  // runs. Update the check runs in `crs` with the new state and the node ID
-  // if unset. Return false and issue diagnostics if the request failed.
+  // Send a GraphQL mutation request `rq` that creates or updates one or more
+  // check runs. The requested build state is taken from each check_run
+  // object. Update the check runs in `crs` with the new data (state, node ID
+  // if unset, and state_synced). Return false and issue diagnostics if the
+  // request failed.
   //
   static bool
   gq_mutate_check_runs (const basic_mark& error,
@@ -297,7 +299,7 @@ namespace brep
           error << "unexpected number of check_run objects in response";
       }
       else
-        error << "failed to update check run: error HTTP response status "
+        error << "failed to mutate check runs: error HTTP response status "
               << sc;
     }
     catch (const json::invalid_json_input& e)
@@ -350,7 +352,7 @@ namespace brep
 
   // Serialize `createCheckRun` mutations for one or more builds to GraphQL.
   //
-  // The conclusion argument (`co`) is required if the build_state is built
+  // The build result argument (`br`) is required if the build_state is built
   // because GitHub does not allow a check run status of completed without a
   // conclusion.
   //
diff --git a/mod/mod-ci-github-gq.hxx b/mod/mod-ci-github-gq.hxx
index 9022fe3..f041ea8 100644
--- a/mod/mod-ci-github-gq.hxx
+++ b/mod/mod-ci-github-gq.hxx
@@ -66,11 +66,8 @@ namespace brep
                        build_state,
                        optional<gq_built_result> = nullopt);
 
-  // Update a check run on GitHub.
-  //
-  // Send a GraphQL request that updates an existing check run. Update `cr`
-  // with the new data (state and state_synced). Return false and issue
-  // diagnostics if the request failed.
+  // Update a check run on GitHub. Update `cr` with the new data (state and
+  // state_synced). Return false and issue diagnostics if the request failed.
   //
   // Note that GitHub allows any state transitions except from built (but
   // built to built is allowed). The latter case is signalled by setting the
-- 
cgit v1.1