pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-05-30 10:31:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

XCM docstring typo fix (#3138)

Browse Source 
* Typo fix in xcm crate.

* Update xcm/src/v0/junction.rs

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
This commit is contained in:
Shaun Wang
2021-05-31 19:49:43 +12:00
committed by GitHub
parent 6e403ec1a4
commit fe97d7eb16
4 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
polkadot/xcm/pallet-xcm/src/lib.rs
+3 -3
View File
@@ -53,8 +53,8 @@ pub mod pallet {
/// The type used to actually dispatch an XCM to its destination. /// The type used to actually dispatch an XCM to its destination.
type XcmRouter: SendXcm; type XcmRouter: SendXcm;
/// Required origin for executing XCM messages, includng the teleport functionality. If successful, /// Required origin for executing XCM messages, including the teleport functionality. If successful,
/// the it resolves to `MultiLocation` which exists as an interior location within this chain's XCM /// then it resolves to `MultiLocation` which exists as an interior location within this chain's XCM
/// context. /// context.
type ExecuteXcmOrigin: EnsureOrigin<Self::Origin, Success=MultiLocation>; type ExecuteXcmOrigin: EnsureOrigin<Self::Origin, Success=MultiLocation>;
@@ -300,7 +300,7 @@ impl<Prefix: Get<MultiLocation>, Body: Get<BodyId>> Filter<MultiLocation> for Is
} }
} }
/// `EnsureOrigin` implementation succeeding with a `MultiLocation` value to recognise and filter the /// `EnsureOrigin` implementation succeeding with a `MultiLocation` value to recognize and filter the
/// `Origin::Xcm` item. /// `Origin::Xcm` item.
pub struct EnsureXcm<F>(PhantomData<F>); pub struct EnsureXcm<F>(PhantomData<F>);
impl<O: OriginTrait + From<Origin>, F: Filter<MultiLocation>> EnsureOrigin<O> for EnsureXcm<F> impl<O: OriginTrait + From<Origin>, F: Filter<MultiLocation>> EnsureOrigin<O> for EnsureXcm<F>
polkadot/xcm/src/v0/mod.rs
+1 -1
View File
@@ -229,7 +229,7 @@ pub enum Xcm<Call> {
}, },
/// A message to notify that the other party in an open channel decided to close it. In particular, /// A message to notify that the other party in an open channel decided to close it. In particular,
/// `inititator` is going to close the channel opened from `sender` to the `recipient`. The close /// `initiator` is going to close the channel opened from `sender` to the `recipient`. The close
/// will be enacted at the next relay-chain session change. This message is meant to be sent by /// will be enacted at the next relay-chain session change. This message is meant to be sent by
/// the relay-chain to a para. /// the relay-chain to a para.
/// ///
polkadot/xcm/src/v0/multi_location.rs
+2 -2
View File
@@ -553,7 +553,7 @@ impl MultiLocation {
} }
} }
/// Mutate `self` so that it is suffixed with `prefix`. The correct normalised form is returned, removing any /// Mutate `self` so that it is suffixed with `prefix`. The correct normalized form is returned, removing any
/// internal `Parent`s. /// internal `Parent`s.
/// ///
/// Does not modify `self` and returns `Err` with `prefix` in case of overflow. /// Does not modify `self` and returns `Err` with `prefix` in case of overflow.
@@ -570,7 +570,7 @@ impl MultiLocation {
} }
} }
/// Mutate `self` so that it is prefixed with `prefix`. The correct normalised form is returned, removing any /// Mutate `self` so that it is prefixed with `prefix`. The correct normalized form is returned, removing any
/// internal `Parent`s. /// internal `Parent`s.
/// ///
/// Does not modify `self` and returns `Err` with `prefix` in case of overflow. /// Does not modify `self` and returns `Err` with `prefix` in case of overflow.
polkadot/xcm/src/v0/traits.rs
+4 -4
View File
@@ -34,10 +34,10 @@ pub enum Error {
UntrustedReserveLocation, UntrustedReserveLocation,
UntrustedTeleportLocation, UntrustedTeleportLocation,
DestinationBufferOverflow, DestinationBufferOverflow,
/// The message and destination was recognised as being reachable but the operation could not be completed. /// The message and destination was recognized as being reachable but the operation could not be completed.
/// A human-readable explanation of the specific issue is provided. /// A human-readable explanation of the specific issue is provided.
SendFailed(#[codec(skip)] &'static str), SendFailed(#[codec(skip)] &'static str),
/// The message and destination combination was not recognised as being reachable. /// The message and destination combination was not recognized as being reachable.
CannotReachDestination(MultiLocation, Xcm<()>), CannotReachDestination(MultiLocation, Xcm<()>),
MultiLocationFull, MultiLocationFull,
FailedToDecode, FailedToDecode,
@@ -92,7 +92,7 @@ pub type Result = result::Result<(), Error>;
/// Local weight type; execution time in picoseconds. /// Local weight type; execution time in picoseconds.
pub type Weight = u64; pub type Weight = u64;
/// Outcome of an XCM excution. /// Outcome of an XCM execution.
#[derive(Clone, Encode, Decode, Eq, PartialEq, Debug)] #[derive(Clone, Encode, Decode, Eq, PartialEq, Debug)]
pub enum Outcome { pub enum Outcome {
/// Execution completed successfully; given weight was used. /// Execution completed successfully; given weight was used.
@@ -162,7 +162,7 @@ impl<C> ExecuteXcm<C> for () {
/// Utility for sending an XCM message. /// Utility for sending an XCM message.
/// ///
/// These can be amalgamted in tuples to form sophisticated routing systems. /// These can be amalgamated in tuples to form sophisticated routing systems.
pub trait SendXcm { pub trait SendXcm {
/// Send an XCM `message` to a given `destination`. /// Send an XCM `message` to a given `destination`.
/// ///