Skip to content

Commit

Permalink
Fix neo-swaps doc strings (#1250)
Browse files Browse the repository at this point in the history
* Improve `SellExecuted` documentation

* Clean up math in comments and doc strings

* Fix formatting
  • Loading branch information
maltekliemann authored Feb 9, 2024
1 parent f755cc1 commit 235f341
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions zrml/neo-swaps/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<u32>;

Expand Down Expand Up @@ -164,7 +164,8 @@ mod pallet {
external_fee_amount: BalanceOf<T>,
},
/// 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<T>,
Expand Down

0 comments on commit 235f341

Please sign in to comment.