Skip to content

Commit 6a5abad

Browse files
authored
[docs] Fix formatting and improve tip message (#22003)
## Description This PR fixes `tip` and `warning` formatting to render correctly. Added new, improved `tip` for how the SDK handles decimals. The previous message was confusing and did not explain how the decimals should be adjusted. ## Test plan I build it locally and tested the formatting. --- ## 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): - [ ] gRPC: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: Signed-off-by: sczembor <stanislaw.czembor@gmail.com>
1 parent 8b335c7 commit 6a5abad

File tree

4 files changed

+6
-7
lines changed

4 files changed

+6
-7
lines changed

docs/content/concepts/cryptography/passkeys.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Refer to the [Typescript SDK support](https://sdk.mystenlabs.com/typescript/cryp
1717

1818
:::info
1919
Passkey support is available in beta in Sui Devnet and Testnet. The Mainnet release is yet to be scheduled.
20-
:::
20+
:::
2121

2222
## Benefits of using passkey
2323

docs/content/concepts/sui-architecture/transaction-lifecycle.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Eventually, the Full node collects effects signatures from a supermajority of va
8383

8484
An effects certificate is a guarantee of transaction finality.
8585

86-
:::
86+
:::
8787

8888
After you or a Full node observes an effects certificate, you are guaranteed that the transaction is going to be included in a checkpoint, which means that the transaction cannot be reverted.
8989

docs/content/standards/deepbookv3-sdk/orders.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,8 @@ placeMarketOrder({ params: PlaceMarketOrderParams });
3737

3838
Use `cancelOrder` to cancel an existing order that is identified by the `orderId` thqt you provide. The call returns a function that takes a `Transaction` object.
3939

40-
::: warn
41-
40+
:::warning
4241
The `orderId` is the protocol `orderId` generated during order placement, which is different from the client `orderId`.
43-
4442
:::
4543

4644
**Parameters**

docs/content/standards/deepbookv3-sdk/pools.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ Pools are shared objects that represent a market. See [Query the Pool](../deepbo
99

1010
The DeepBookV3 SDK exposes functions that you can call to read the state of a pool. These functions typically require a `managerKey`, `coinKey`, `poolKey`, or a combination of these. For details on these keys, see [DeepBookV3 SDK](../deepbookv3-sdk.mdx#keys). The SDK includes some default keys that you can view in the `constants.ts` file.
1111

12-
::: tip
13-
Decimal adjust all input quantities. All outputs are decimal adjusted.
12+
:::tip SDK Unit Handling
13+
Input amounts, quantities, and prices should be provided in standard decimal format (e.g., `10.5` SUI, `0.00001` nBTC). The SDK handles conversion to base units internally. Returned amounts are also in standard decimal format.
1414
:::
1515

16+
1617
### account
1718

1819
Use `account` to retrieve the account information for a `BalanceManager` in a pool, which has the following form:

0 commit comments

Comments
 (0)