From ed2a0c7acbba040d351745f0052f01b5ecb67877 Mon Sep 17 00:00:00 2001 From: Justin Starry Date: Sun, 29 Mar 2020 22:18:02 +0800 Subject: [PATCH] chore: improve EpochSchedule docs --- web3.js/src/connection.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/web3.js/src/connection.js b/web3.js/src/connection.js index 119153cb3c..27d557f7a6 100644 --- a/web3.js/src/connection.js +++ b/web3.js/src/connection.js @@ -189,11 +189,11 @@ const GetEpochInfoResult = struct({ * (see https://docs.solana.com/terminology#epoch) * * @typedef {Object} EpochSchedule - * @property {number} slots_per_epoch - * @property {number} leader_schedule_slot_offset - * @property {boolean} warmup - * @property {number} first_normal_epoch - * @property {number} first_normal_slot + * @property {number} slotsPerEpoch The maximum number of slots in each epoch + * @property {number} leaderScheduleSlotOffset The number of slots before beginning of an epoch to calculate a leader schedule for that epoch + * @property {boolean} warmup Indicates whether epochs start short and grow + * @property {number} firstNormalEpoch The first epoch with `slotsPerEpoch` slots + * @property {number} firstNormalSlot The first slot of `firstNormalEpoch` */ const GetEpochScheduleResult = struct({ slotsPerEpoch: 'number',