Update documentation
1 unresolved thread
1 unresolved thread
Complete and format the Rust documentation to ensure the autogenerated documentation includes comprehensive information, especially for public methods, traits, structs, and storage. This will allow downstream developers to refer directly to the documentation without needing to browse the code.
-
Incode pallet description: Delete the readme and include pallet documentation directly in the code (another solution would have been #![doc = include_str!("../README.md")]
, but it is impractical when displaying the source code from the documentation using the "source" tag). -
Document every type. -
Document every storage. -
Document every trait. -
Document every public method. -
Fix #240 (closed).
Edited by Benjamin Gallois
Merge request reports
Activity
added RN-silent label
assigned to @bgallois
added 2 commits
requested review from @HugoTrentesaux
mentioned in merge request !269 (merged)
added 10 commits
Toggle commit listmentioned in commit eeb5d5f8
101 131 + MaybeSerializeDeserialize 102 132 + Debug 103 133 + MaxEncodedLen; 104 /// Identifier for an authority-member 134 135 /// Identifier type for an authority-member. 105 136 type MemberId: Copy + Ord + MaybeSerializeDeserialize + Parameter; 106 /// Something that gives the IdtyId of an AccountId and reverse 137 138 /// Something that gives the IdtyIndex of an AccountId and reverse. 107 139 type IdtyAttr: duniter_primitives::Idty<Self::IdtyIndex, Self::AccountId>; 108 // /// Something that give the owner key of an identity 140 141 /// Something that gives the AccountId of an identity. 109 142 type IdtyIdOfAuthorityId: Convert<Self::MemberId, Option<Self::IdtyIndex>>;
Please register or sign in to reply