Skip to content

Commit ed19fca

Browse files
authored
Merge pull request 0xMiden#1144 from 0xMiden/mmagician-websdk-docs
chore: update web client docs (housekeeping)
2 parents e799083 + 4d1760c commit ed19fca

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

crates/web-client/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/src/web-client/api/classes/JsStateSyncUpdate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ the ith block, with 1 meaning relevant and 0 meaning not relevant.
3535
> **blockNum**: `string`
3636
3737
The block number for this update, stored as a string since it will be
38-
persisted in IndexedDB.
38+
persisted in `IndexedDB`.
3939

4040
***
4141

@@ -68,7 +68,7 @@ verification.
6868

6969
> **newBlockNums**: `string`[]
7070
71-
The block numbers corresponding to each header in flattened_new_block_headers.
71+
The block numbers corresponding to each header in `flattened_new_block_headers`.
7272
This vec should have the same length as the number of headers, with each index
7373
representing the block number for the header at that same index.
7474

docs/src/web-client/api/classes/WebClient.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,9 @@
126126

127127
> **exportStore**(): `Promise`\<`any`\>
128128
129-
Retrieves the entire underlying web store and returns it as a JsValue
129+
Retrieves the entire underlying web store and returns it as a `JsValue`
130130

131-
Meant to be used in conjunction with the force_import_store method
131+
Meant to be used in conjunction with the `force_import_store` method
132132

133133
#### Returns
134134

0 commit comments

Comments
 (0)