Skip to content

Commit

Permalink
fixup! docs: add JSDoc comments to enhance function documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rabi-siddique committed Oct 8, 2024
1 parent 747d3e1 commit cafe7fd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
14 changes: 12 additions & 2 deletions packages/inter-protocol/src/proposals/replaceElectorate.js
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down Expand Up @@ -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;
Expand Down

0 comments on commit cafe7fd

Please sign in to comment.