Skip to content

Commit

Permalink
[kiosk sdk] Fix doc comment (#20068)
Browse files Browse the repository at this point in the history
## 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:
  • Loading branch information
manolisliolios authored Oct 29, 2024
1 parent d526a74 commit 4166d71
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/chilly-pillows-remember.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@mysten/kiosk': patch
---

Fix doc comment on `getKiosk` command
4 changes: 2 additions & 2 deletions sdk/kiosk/src/client/kiosk-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<KioskData> {
Expand Down

0 comments on commit 4166d71

Please sign in to comment.