difftreelog
doc(rmrk): minor edits for clarity
in: master
2 files changed
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth67//! Parts are defined in the Base to which they belong. Parts can be either67//! Parts are defined in the Base to which they belong. Parts can be either68//! of the `slot` type or `fixed` type. Slots are intended for equippables.68//! of the `slot` type or `fixed` type. Slots are intended for equippables.69//! Note that "part of something" and "Part of a Base" can be easily confused,69//! Note that "part of something" and "Part of a Base" can be easily confused,70//! and in this documentation these words are distinguished by the capital letter.70//! and so in this documentation these words are distinguished by the capital letter.71//!71//!72//! - **Theme:** Named objects of variable => value pairs which get interpolated into72//! - **Theme:** Named objects of variable => value pairs which get interpolated into73//! the Base's `themable` Parts. Themes can hold any value, but are often represented73//! the Base's `themable` Parts. Themes can hold any value, but are often represented78//! - **Scoped properties:** Properties that are normally obscured from users.78//! - **Scoped properties:** Properties that are normally obscured from users.79//! Their purpose is to contain structured metadata that was not included in the Unique standard79//! Their purpose is to contain structured metadata that was not included in the Unique standard80//! for collections and tokens, meant to be operated on by proxies and other outliers.80//! for collections and tokens, meant to be operated on by proxies and other outliers.81//! Scoped properties are prefixed with `some-scope:`, where `some-scope` is81//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is82//! an arbitrary keyword, like "rmrk", and `:` is an unacceptable symbol in user-defined82//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined83//! properties, which, along with other safeguards, makes them impossible to tamper with.83//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.84//!84//!85//! - **Auxiliary properties:** A slightly different structure of properties,85//! - **Auxiliary properties:** A slightly different structure of properties,86//! trading universality of use for more convenient storage, writes and access.86//! trading universality of use for more convenient storage, writes and access.91//! An external user is supposed to be able to utilize this proxy as they would91//! An external user is supposed to be able to utilize this proxy as they would92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions93//! are off-limits to RMRK collections and tokens, and vice versa. However,93//! are off-limits to RMRK collections and tokens, and vice versa. However,94//! the information stored on chain can be freely interpreted by storage reads and RPCs.94//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.95//!95//!96//! ### ID Mapping96//! ### ID Mapping97//!97//!115//!115//!116//! ### Collection and NFT Types, and Base, Parts and Themes Handling116//! ### Collection and NFT Types, and Base, Parts and Themes Handling117//!117//!118//! RMRK introduces the concept of a Base, which is a catalgoue 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 functionality120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes121//! are the collection's NFTs. See [`CollectionType`] and [`NftType`].121//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].122//!122//!123//! ## Interface123//! ## Interface124//!124//!pallets/proxy-rmrk-equip/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-equip/src/lib.rs
+++ b/pallets/proxy-rmrk-equip/src/lib.rs
@@ -70,7 +70,7 @@
//! Parts are defined in the Base to which they belong. Parts can be either
//! of the `slot` type or `fixed` type. Slots are intended for equippables.
//! Note that "part of something" and "Part of a Base" can be easily confused,
-//! and in this documentation these words are distinguished by the capital letter.
+//! and so in this documentation these words are distinguished by the capital letter.
//!
//! - **Theme:** Named objects of variable => value pairs which get interpolated into
//! the Base's `themable` Parts. Themes can hold any value, but are often represented
@@ -81,9 +81,9 @@
//! - **Scoped properties:** Properties that are normally obscured from users.
//! Their purpose is to contain structured metadata that was not included in the Unique standard
//! for collections and tokens, meant to be operated on by proxies and other outliers.
-//! Scoped properties are prefixed with `some-scope:`, where `some-scope` is
-//! an arbitrary keyword, like "rmrk", and `:` is an unacceptable symbol in user-defined
-//! properties, which, along with other safeguards, makes them impossible to tamper with.
+//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is
+//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined
+//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.
//!
//! - **Auxiliary properties:** A slightly different structure of properties,
//! trading universality of use for more convenient storage, writes and access.
@@ -94,7 +94,7 @@
//! An external user is supposed to be able to utilize this proxy as they would
//! utilize RMRK, and get exactly the same results. Normally, Unique transactions
//! are off-limits to RMRK collections and tokens, and vice versa. However,
-//! the information stored on chain can be freely interpreted by storage reads and RPCs.
+//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.
//!
//! ### ID Mapping
//!
@@ -118,10 +118,10 @@
//!
//! ### Collection and NFT Types, and Base, Parts and Themes Handling
//!
-//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,
+//! 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
//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes
-//! are the collection's NFTs. See [`CollectionType`] and [`NftType`].
+//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].
//!
//! ## Interface
//!