From 557c7d4224649110249b061acbb31038c2780f9c Mon Sep 17 00:00:00 2001
From: Richard Moore <github@ricmoo.com>
Date: Tue, 14 Feb 2023 12:24:53 -0500
Subject: [PATCH] docs: added jsdocs to update-version generated output

---
 src.ts/_admin/update-version.ts | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/src.ts/_admin/update-version.ts b/src.ts/_admin/update-version.ts
index 0948338d91..bbf63410f4 100644
--- a/src.ts/_admin/update-version.ts
+++ b/src.ts/_admin/update-version.ts
@@ -19,9 +19,8 @@ async function getNpmPackage(name: string): Promise<any> {
 
     return cache[name] || null;
 }
-
 function writeVersion(version: string): void {
-    const content = `export const version: string = "${ version }";\n`;
+    const content = `/* Do NOT modify this file; see /src.ts/_admin/update-version.ts */\n\n/**\n *  The current version of Ethers.\n */\nexport const version: string = "${ version }";\n`;
     atomicWrite(resolve("src.ts/_version.ts"), content);
 }