docs: added jsdocs to update-version generated output

ethers-io · Feb 14, 2023 · 557c7d4 · 557c7d4
1 parent 83957dc
commit 557c7d4
Showing 1 changed file with 1 addition and 2 deletions.
diff --git 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);
 }