difftreelog
doc(rmrk): requested clarifications
in: master
3 files changed
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/lib.rs
+++ b/pallets/proxy-rmrk-core/src/lib.rs
@@ -113,7 +113,7 @@
//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,
//! makes them impossible to tamper with.
//!
-//! ### Collection and NFT Types, and Base, Parts and Themes Handling
+//! ### Collection and NFT Types, or Base, Parts and Themes Handling
//!
//! RMRK introduces the concept of a Base, which is a catalogue of Parts,
//! possible components of an NFT. Due to its similarity with the functionality
pallets/proxy-rmrk-core/src/misc.rsdiffbeforeafterboth20use codec::{Encode, Decode, Error};20use codec::{Encode, Decode, Error};212122/// Match errors from one type to another and return an error22/// Match errors from one type to another and return an error23/// if a match is successful.23/// if a match is successful. This macro expects a pattern matcher24#[macro_export]24#[macro_export]25macro_rules! map_unique_err_to_proxy {25macro_rules! map_unique_err_to_proxy {26 (match $err:ident { $($unique_err_ty:ident :: $unique_err:ident => $proxy_err:ident),+ $(,)? }) => {26 (match $err:ident { $($unique_err_ty:ident :: $unique_err:ident => $proxy_err:ident),+ $(,)? }) => {34 };34 };35}35}363637/// Interface to decode bytes from a bounded vector into an arbitrary type.37/// Interface to decode some serialized bytes into an arbitrary type `T`,38/// preferably if these bytes were originally encoded from `T`.38pub trait RmrkDecode<T: Decode, S> {39pub trait RmrkDecode<T: Decode, S> {39 /// Try to decode bytes from a bounded vector into an arbitrary type.40 /// Try to decode self into an arbitrary type `T`.40 fn decode(&self) -> Result<T, Error>;41 fn decode(&self) -> Result<T, Error>;41}42}424348 }49 }49}50}505151/// Interface to "rebind", change the limit of a bounded byte vector.52/// Interface to "rebind" - change the limit of a bounded byte vector.52pub trait RmrkRebind<T, S> {53pub trait RmrkRebind<T, S> {53 /// Try to change the limit of a bounded byte vector.54 /// Try to change the limit of a bounded byte vector.54 fn rebind(&self) -> Result<BoundedVec<u8, S>, Error>;55 fn rebind(&self) -> Result<BoundedVec<u8, S>, Error>;pallets/proxy-rmrk-equip/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-equip/src/lib.rs
+++ b/pallets/proxy-rmrk-equip/src/lib.rs
@@ -116,7 +116,7 @@
//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,
//! makes them impossible to tamper with.
//!
-//! ### Collection and NFT Types, and Base, Parts and Themes Handling
+//! ### Collection and NFT Types, or Base, Parts and Themes Handling
//!
//! RMRK introduces the concept of a Base, which is a catalogue of Parts,
//! possible components of an NFT. Due to its similarity with the functionality
@@ -414,7 +414,8 @@
}
impl<T: Config> Pallet<T> {
- /// Create or renew an NFT serving as a Part inside a collection serving as a Base.
+ /// Create (or overwrite) a Part in a Base.
+ /// The Part and the Base are represented as an NFT and a Collection.
fn create_part(
sender: &T::CrossAccountId,
collection: &NonfungibleHandle<T>,