From d1d995bace2f0b4c2b5852d42afceddd39a8d8fb Mon Sep 17 00:00:00 2001 From: Sacha Lansky Date: Sat, 29 Jul 2023 14:48:55 +0200 Subject: [PATCH] [fix docs compiler warnings] Nicks pallet (#14668) * fix missing docs warning * fmt * add #![deny(missing_docs)] --- frame/nicks/src/lib.rs | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/frame/nicks/src/lib.rs b/frame/nicks/src/lib.rs index 612443f5dfd56..0a68f7d7142dc 100644 --- a/frame/nicks/src/lib.rs +++ b/frame/nicks/src/lib.rs @@ -36,6 +36,7 @@ //! * `clear_name` - Remove an account's associated name; the deposit is returned. //! * `kill_name` - Forcibly remove the associated name; the deposit is lost. +#![deny(missing_docs)] #![cfg_attr(not(feature = "std"), no_std)] use frame_support::traits::{Currency, OnUnbalanced, ReservableCurrency}; @@ -86,18 +87,37 @@ pub mod pallet { #[pallet::generate_deposit(pub(super) fn deposit_event)] pub enum Event { /// A name was set. - NameSet { who: T::AccountId }, + NameSet { + /// The account for which the name was set. + who: T::AccountId, + }, /// A name was forcibly set. - NameForced { target: T::AccountId }, + NameForced { + /// The account whose name was forcibly set. + target: T::AccountId, + }, /// A name was changed. - NameChanged { who: T::AccountId }, + NameChanged { + /// The account for which the name was changed. + who: T::AccountId, + }, /// A name was cleared, and the given balance returned. - NameCleared { who: T::AccountId, deposit: BalanceOf }, + NameCleared { + /// The account for which the name was cleared. + who: T::AccountId, + /// The deposit returned. + deposit: BalanceOf, + }, /// A name was removed and the given balance slashed. - NameKilled { target: T::AccountId, deposit: BalanceOf }, + NameKilled { + /// The account for which the name was removed. + target: T::AccountId, + /// The deposit returned. + deposit: BalanceOf, + }, } - /// Error for the nicks pallet. + /// Error for the Nicks pallet. #[pallet::error] pub enum Error { /// A name is too short.