difftreelog
doc(rmrk): requested clarifications
in: master
3 files changed
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth113//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,113//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,114//! makes them impossible to tamper with.114//! makes them impossible to tamper with.115//!115//!116//! ### Collection and NFT Types, and Base, Parts and Themes Handling116//! ### Collection and NFT Types, or Base, Parts and Themes Handling117//!117//!118//! RMRK introduces the concept of a Base, which is a catalogue of Parts,118//! RMRK introduces the concept of a Base, which is a catalogue of Parts,119//! possible components of an NFT. Due to its similarity with the functionality119//! possible components of an NFT. Due to its similarity with the functionalitypallets/proxy-rmrk-core/src/misc.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/misc.rs
+++ b/pallets/proxy-rmrk-core/src/misc.rs
@@ -20,7 +20,7 @@
use codec::{Encode, Decode, Error};
/// Match errors from one type to another and return an error
-/// if a match is successful.
+/// if a match is successful. This macro expects a pattern matcher
#[macro_export]
macro_rules! map_unique_err_to_proxy {
(match $err:ident { $($unique_err_ty:ident :: $unique_err:ident => $proxy_err:ident),+ $(,)? }) => {
@@ -34,9 +34,10 @@
};
}
-/// Interface to decode bytes from a bounded vector into an arbitrary type.
+/// Interface to decode some serialized bytes into an arbitrary type `T`,
+/// preferably if these bytes were originally encoded from `T`.
pub trait RmrkDecode<T: Decode, S> {
- /// Try to decode bytes from a bounded vector into an arbitrary type.
+ /// Try to decode self into an arbitrary type `T`.
fn decode(&self) -> Result<T, Error>;
}
@@ -48,7 +49,7 @@
}
}
-/// Interface to "rebind", change the limit of a bounded byte vector.
+/// Interface to "rebind" - change the limit of a bounded byte vector.
pub trait RmrkRebind<T, S> {
/// Try to change the limit of a bounded byte vector.
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>,