From 4166d71653835aa3b57bfa52d0d57e2e26f31fd6 Mon Sep 17 00:00:00 2001 From: Manolis Liolios Date: Tue, 29 Oct 2024 22:40:58 +0200 Subject: [PATCH] [kiosk sdk] Fix doc comment (#20068) ## Description Fix doc comment to match the expected arguments on `getKiosk` call. ## Test plan How did you test the new or updated feature? --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API: --- .changeset/chilly-pillows-remember.md | 5 +++++ sdk/kiosk/src/client/kiosk-client.ts | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/chilly-pillows-remember.md diff --git a/.changeset/chilly-pillows-remember.md b/.changeset/chilly-pillows-remember.md new file mode 100644 index 0000000000000..842004d9cc0da --- /dev/null +++ b/.changeset/chilly-pillows-remember.md @@ -0,0 +1,5 @@ +--- +'@mysten/kiosk': patch +--- + +Fix doc comment on `getKiosk` command diff --git a/sdk/kiosk/src/client/kiosk-client.ts b/sdk/kiosk/src/client/kiosk-client.ts index 23fe8312896af..0c740e05524a7 100644 --- a/sdk/kiosk/src/client/kiosk-client.ts +++ b/sdk/kiosk/src/client/kiosk-client.ts @@ -77,8 +77,8 @@ export class KioskClient { /** * Fetches the kiosk contents. - * @param kioskId The ID of the kiosk to fetch. - * @param options Optioal + * @param id The ID of the kiosk to fetch. + * @param options Optional to control the fetch behavior. * @returns */ async getKiosk({ id, options }: { id: string; options?: FetchKioskOptions }): Promise {