chore: update param docs

AztecProtocol · Dec 1, 2023 · 3f478a1 · 3f478a1
1 parent 269f7bc
commit 3f478a1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts b/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts
@@ -135,7 +135,7 @@ export class ServerWorldStateSynchronizer implements WorldStateSynchronizer {
   /**
    * Forces an immediate sync
    * @param minBlockNumber - The minimum block number that we must sync to
-   * @returns A promise that resolves to the blockNumber the world state has synced to
+   * @returns A promise that resolves with the block number the world state was synced to
    */
   public async syncImmediate(minBlockNumber?: number): Promise<number> {
     if (this.currentState !== WorldStateRunningState.RUNNING) {

diff --git a/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts b/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts
@@ -48,7 +48,7 @@ export interface WorldStateSynchronizer {
   /**
    * Forces an immediate sync to an optionally provided minimum block number
    * @param minBlockNumber - The minimum block number that we must sync to
-   * @returns A promise that resolves once the sync has completed.
+   * @returns A promise that resolves with the block number the world state was synced to
    */
   syncImmediate(minBlockNumber?: number): Promise<number>;