Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix neo-swaps doc strings #1250

Merged
merged 3 commits into from
Feb 9, 2024
+4 −3
Merged

Fix neo-swaps doc strings #1250

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34815b0
Improve `SellExecuted` documentation
maltekliemann Jan 28, 2024
9993a82
Clean up math in comments and doc strings
maltekliemann Jan 28, 2024
421f6f8
Fix formatting
maltekliemann Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions zrml/neo-swaps/src/lib.rs
View file
Open in desktop
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
Loading