fix typos in identity pallet docs (#4350)

This commit is contained in:
joe petrowski
2019-12-10 23:31:27 +01:00
committed by Benjamin Kampmann
parent f0cc89a4b0
commit 1ff41742bd
+8 -7
View File
@@ -195,7 +195,8 @@ pub enum Judgement<
/// The data appears to be reasonably acceptable in terms of its accuracy, however no in depth
/// checks (such as in-person meetings or formal KYC) have been conducted.
Reasonable,
/// The target is known directly by the registrar and can fully attest to being accurate.
/// The target is known directly by the registrar and the registrar can fully attest to the
/// the data's accuracy.
KnownGood,
/// The data was once good but is currently out of date. There is no malicious intent in the
/// inaccuracy. This judgement can be removed through updating the data.
@@ -269,11 +270,11 @@ impl Decode for IdentityFields {
#[derive(Clone, Encode, Decode, Eq, PartialEq, RuntimeDebug)]
#[cfg_attr(test, derive(Default))]
pub struct IdentityInfo {
/// Additional fields of the identity that are not catered for with the structs explicit
/// Additional fields of the identity that are not catered for with the struct's explicit
/// fields.
pub additional: Vec<(Data, Data)>,
/// A reasonable display name for the controller of the account. This should be whatever is it
/// A reasonable display name for the controller of the account. This should be whatever it is
/// that it is typically known as and should not be confusable with other entities, given
/// reasonable context.
///
@@ -306,7 +307,7 @@ pub struct IdentityInfo {
/// The PGP/GPG public key of the controller of the account.
pub pgp_fingerprint: Option<[u8; 20]>,
/// An graphic image representing the controller of the account. Should be a company,
/// A graphic image representing the controller of the account. Should be a company,
/// organization or project logo or a headshot in the case of a human.
pub image: Data,
}
@@ -319,7 +320,7 @@ pub struct IdentityInfo {
pub struct Registration<
Balance: Encode + Decode + Copy + Clone + Debug + Eq + PartialEq
> {
/// Judgements from the registrars on this identity. Stored ordered by RegistrarIndex. There
/// Judgements from the registrars on this identity. Stored ordered by `RegistrarIndex`. There
/// may be only a single judgement from each registrar.
pub judgements: Vec<(RegistrarIndex, Judgement<Balance>)>,
@@ -340,7 +341,7 @@ impl <
}
}
/// Information concerning the a registrar.
/// Information concerning a registrar.
#[derive(Clone, Encode, Decode, Eq, PartialEq, RuntimeDebug)]
pub struct RegistrarInfo<
Balance: Encode + Decode + Clone + Debug + Eq + PartialEq,
@@ -349,7 +350,7 @@ pub struct RegistrarInfo<
/// The account of the registrar.
pub account: AccountId,
/// Amount required to be given to the registrar for them to check the account.
/// Amount required to be given to the registrar for them to provide judgement.
pub fee: Balance,
/// Relevant fields for this registrar. Registrar judgements are limited to attestations on