From f5768fee9d0977a42f344cf0cfdae74ca80a23b9 Mon Sep 17 00:00:00 2001
From: Francois Kritzinger <francois@codesynthesis.com>
Date: Fri, 29 Nov 2024 08:34:09 +0200
Subject: Review exceptions thrown by github-ci API functions

---
 mod/mod-ci-github.hxx | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'mod/mod-ci-github.hxx')

diff --git a/mod/mod-ci-github.hxx b/mod/mod-ci-github.hxx
index b88d5e4..c38462a 100644
--- a/mod/mod-ci-github.hxx
+++ b/mod/mod-ci-github.hxx
@@ -107,7 +107,9 @@ namespace brep
     optional<string>
     generate_jwt (const basic_mark& trace, const basic_mark& error) const;
 
-    // Authenticate to GitHub as an app installation.
+    // Authenticate to GitHub as an app installation. Return the installation
+    // access token (IAT). Issue diagnostics and return nullopt if something
+    // goes wrong.
     //
     optional<gh_installation_access_token>
     obtain_installation_access_token (uint64_t install_id,
-- 
cgit v1.1