From cafe7fd6b565588faf24c20f4c8596f7ace1d523 Mon Sep 17 00:00:00 2001
From: rabi-siddique <rabisiddique27@gmail.com>
Date: Tue, 8 Oct 2024 09:22:02 +0500
Subject: [PATCH] fixup! docs: add JSDoc comments to enhance function
 documentation

---
 .../inter-protocol/replace-electorate-core.js      | 14 ++++++++++++++
 .../src/proposals/replaceElectorate.js             | 14 ++++++++++++--
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/packages/builders/scripts/inter-protocol/replace-electorate-core.js b/packages/builders/scripts/inter-protocol/replace-electorate-core.js
index cc3de0913ab3..a856177f7d0d 100644
--- a/packages/builders/scripts/inter-protocol/replace-electorate-core.js
+++ b/packages/builders/scripts/inter-protocol/replace-electorate-core.js
@@ -1,3 +1,17 @@
+/**
+ * @file build core eval script to replace EC committee and charter
+ * Usage:
+ *   To run this script, use the following command format in the CLI:
+ *   agoric run replace-electorate-core.js [ENVIRONMENT]
+ *   where [ENVIRONMENT] is one of the following:
+ *     - MAINNET
+ *     - DEVNET
+ *     - A3P_INTEGRATION
+ *     - BOOTSTRAP_TEST
+ *
+ *   Example:
+ *     agoric run replace-electorate-core.js MAINNET
+ */
 /* global process */
 import { makeHelpers } from '@agoric/deploy-script-support';
 import { getManifestForReplaceAllElectorates } from '@agoric/inter-protocol/src/proposals/replaceElectorate.js';
diff --git a/packages/inter-protocol/src/proposals/replaceElectorate.js b/packages/inter-protocol/src/proposals/replaceElectorate.js
index 14ad06ba8fe7..1eacc1bb8323 100644
--- a/packages/inter-protocol/src/proposals/replaceElectorate.js
+++ b/packages/inter-protocol/src/proposals/replaceElectorate.js
@@ -1,3 +1,14 @@
+/**
+ * @file A proposal to replace the EC committee and charter.
+ *
+ *   This script manages configuration updates, distributes invitations, and
+ *   establishes committees using specified voter addresses and related
+ *   parameters.
+ *
+ *   See `@agoric/builders/scripts/inter-protocol/replace-electorate-core.js` for
+ *   the proposal builder.
+ */
+
 // @ts-check
 import { E } from '@endo/eventual-send';
 import {
@@ -130,9 +141,8 @@ const inviteECMembers = async (
  * Starts a new Economic Committee (EC) by creating an instance with the
  * provided committee specifications.
  *
- * - @param {EconomyBootstrapPowers} powers - The resources and capabilities
+ * @param {EconomyBootstrapPowers} powers - The resources and capabilities
  *   required to start the committee.
- *
  * @param {{
  *   options: {
  *     committeeName: string;