Skip to content

Commit

Permalink
[fix docs compiler warnings] Nicks pallet (paritytech#14668)
Browse files Browse the repository at this point in the history
* fix missing docs warning

* fmt

* add #![deny(missing_docs)]
  • Loading branch information
Sacha Lansky authored Jul 29, 2023
1 parent fd7db4e commit d1d995b
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions frame/nicks/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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};
Expand Down Expand Up @@ -86,18 +87,37 @@ pub mod pallet {
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// 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<T> },
NameCleared {
/// The account for which the name was cleared.
who: T::AccountId,
/// The deposit returned.
deposit: BalanceOf<T>,
},
/// A name was removed and the given balance slashed.
NameKilled { target: T::AccountId, deposit: BalanceOf<T> },
NameKilled {
/// The account for which the name was removed.
target: T::AccountId,
/// The deposit returned.
deposit: BalanceOf<T>,
},
}

/// Error for the nicks pallet.
/// Error for the Nicks pallet.
#[pallet::error]
pub enum Error<T> {
/// A name is too short.
Expand Down

0 comments on commit d1d995b

Please sign in to comment.