From 235f3415be0fe8c69eb5d3d20aef8a94d1c8990a Mon Sep 17 00:00:00 2001 From: Malte Kliemann Date: Fri, 9 Feb 2024 14:05:52 +0100 Subject: [PATCH] Fix neo-swaps doc strings (#1250) * Improve `SellExecuted` documentation * Clean up math in comments and doc strings * Fix formatting --- zrml/neo-swaps/src/lib.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/zrml/neo-swaps/src/lib.rs b/zrml/neo-swaps/src/lib.rs index ed0a3f30a..6b17e91a1 100644 --- a/zrml/neo-swaps/src/lib.rs +++ b/zrml/neo-swaps/src/lib.rs @@ -126,8 +126,8 @@ mod pallet { type WeightInfo: WeightInfoZeitgeist; - /// The maximum allowed liquidity tree depth per pool. Each pool can support `2^(depth + 1) - /// - 1` liquidity providers. **Must** be less than 16. + /// The maximum allowed liquidity tree depth per pool. Each pool can support + /// `2^(depth + 1) - 1` liquidity providers. **Must** be less than 16. #[pallet::constant] type MaxLiquidityTreeDepth: Get; @@ -164,7 +164,8 @@ mod pallet { external_fee_amount: BalanceOf, }, /// Informant sold a position. `amount_out` is the amount of collateral received by `who`, - /// including swap and external fees. + /// with swap and external fees not yet deducted. The actual amount received is + /// `amount_out - swap_fee_amount - external_fee_amount`. SellExecuted { who: T::AccountId, market_id: MarketIdOf,