From c7a94c979d8510f500182a32005bbbce141a5487 Mon Sep 17 00:00:00 2001
From: "Michael B. Gale" <mbg@github.com>
Date: Tue, 23 Jun 2026 16:55:23 +0100
Subject: [PATCH] Add `getRemoteConfig` JSDoc

---
 src/config/file.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/config/file.ts b/src/config/file.ts
index 693a35306..420e418e0 100644
--- a/src/config/file.ts
+++ b/src/config/file.ts
@@ -39,6 +39,16 @@ export function getConfigFileInput(
   return undefined;
 }
 
+/**
+ * Attempts to fetch a `UserConfig` from a remote `address`.
+ *
+ * @param logger The logger to use.
+ * @param configFile The remote address of the configuration file.
+ * @param apiDetails Information about how to connect to the API.
+ * @param validateConfig Whether to validate the configuration.
+ *
+ * @returns The `UserConfig`, if it could be fetched and parsed successfully.
+ */
 export async function getRemoteConfig(
   logger: Logger,
   configFile: string,