From 3e48265301c807b6fdd5d72f8ba809e55dd6b979 Mon Sep 17 00:00:00 2001 From: Ankan Date: Sat, 26 Oct 2024 17:09:47 +0200 Subject: [PATCH] add rustdoc for migrate --- substrate/frame/staking/src/pallet/mod.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/substrate/frame/staking/src/pallet/mod.rs b/substrate/frame/staking/src/pallet/mod.rs index 750286fcb715..20be42b63b2d 100644 --- a/substrate/frame/staking/src/pallet/mod.rs +++ b/substrate/frame/staking/src/pallet/mod.rs @@ -2181,6 +2181,13 @@ pub mod pallet { Ok(()) } + /// Migrates permissionlessly a stash from locks to holds. + /// + /// This removes the old lock on the stake and creates a hold on it atomically. If all + /// stake cannot be held, the best effort is made to hold as much as possible. The remaining + /// stake is removed from the ledger. + /// + /// The fee is waived if the migration is successful. #[pallet::call_index(30)] #[pallet::weight(T::WeightInfo::migrate_currency())] pub fn migrate_currency(