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.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.rsdiffbeforeafterboth116//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,116//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,117//! makes them impossible to tamper with.117//! makes them impossible to tamper with.118//!118//!119//! ### Collection and NFT Types, and Base, Parts and Themes Handling119//! ### Collection and NFT Types, or Base, Parts and Themes Handling120//!120//!121//! RMRK introduces the concept of a Base, which is a catalogue of Parts,121//! RMRK introduces the concept of a Base, which is a catalogue of Parts,122//! possible components of an NFT. Due to its similarity with the functionality122//! possible components of an NFT. Due to its similarity with the functionality414}414}415415416impl<T: Config> Pallet<T> {416impl<T: Config> Pallet<T> {417 /// Create or renew an NFT serving as a Part inside a collection serving as a Base.417 /// Create (or overwrite) a Part in a Base.418 /// The Part and the Base are represented as an NFT and a Collection.418 fn create_part(419 fn create_part(419 sender: &T::CrossAccountId,420 sender: &T::CrossAccountId,420 collection: &NonfungibleHandle<T>,421 collection: &NonfungibleHandle<T>,