documentation grammar

Co-authored-by: Adrian Catangiu <adrian@parity.io>

frame/merkle-mountain-range/rpc/src/lib.rs

@@ -84,7 +84,7 @@ pub trait MmrApi<BlockHash, BlockNumber, MmrHash> {
 	/// Generate an MMR proof for the given `block_numbers`.
 	///
 	/// This method calls into a runtime with MMR pallet included and attempts to generate
-	/// a MMR proof for the set of blocks that have the given `block_numbers` with MMR given the
+	/// an MMR proof for the set of blocks that have the given `block_numbers` with the MMR root at
 	/// `best_known_block_number`. `best_known_block_number` must be larger than all the
 	/// `block_numbers` for the function to succeed.
 	///
@@ -111,7 +111,7 @@ pub trait MmrApi<BlockHash, BlockNumber, MmrHash> {
 	/// Verify an MMR `proof`.
 	///
 	/// This method calls into a runtime with MMR pallet included and attempts to verify
-	/// a MMR proof.
+	/// an MMR proof.
 	///
 	/// Returns `true` if the proof is valid, else returns the verification error.
 	#[method(name = "mmr_verifyProof")]
@@ -120,7 +120,7 @@ pub trait MmrApi<BlockHash, BlockNumber, MmrHash> {
 	/// Verify an MMR `proof` statelessly given an `mmr_root`.
 	///
 	/// This method calls into a runtime with MMR pallet included and attempts to verify
-	/// a MMR proof against a provided mmr root.
+	/// an MMR proof against a provided MMR root.
 	///
 	/// Returns `true` if the proof is valid, else returns the verification error.
 	#[method(name = "mmr_verifyProofStateless")]
@@ -236,7 +236,7 @@ where
 	}
 }
 
-/// Converts a mmr-specific error into a [`CallError`].
+/// Converts an mmr-specific error into a [`CallError`].
 fn mmr_error_into_rpc_error(err: MmrError) -> CallError {
 	let data = format!("{:?}", err);
 	match err {

frame/merkle-mountain-range/src/lib.rs

@@ -22,7 +22,7 @@
 //! Details on Merkle Mountain Ranges (MMRs) can be found here:
 //! <https://github.com/mimblewimble/grin/blob/master/doc/mmr.md>
 //!
-//! The MMR pallet constructs a MMR from leaf data obtained on every block from
+//! The MMR pallet constructs an MMR from leaf data obtained on every block from
 //! `LeafDataProvider`. MMR nodes are stored both in:
 //! - on-chain storage - hashes only; not full leaf content)
 //! - off-chain storage - via Indexing API we push full leaf content (and all internal nodes as
@@ -50,7 +50,7 @@
 //!
 //! Secondary use case is to archive historical data, but still be able to retrieve them on-demand
 //! if needed. For instance if parent block hashes are stored in the MMR it's possible at any point
-//! in time to provide a MMR proof about some past block hash, while this data can be safely pruned
+//! in time to provide an MMR proof about some past block hash, while this data can be safely pruned
 //! from on-chain storage.
 //!
 //! NOTE This pallet is experimental and not proven to work in production.
@@ -103,7 +103,7 @@ pub trait WeightInfo {
 	fn on_initialize(peaks: NodeIndex) -> Weight;
 }
 
-/// A MMR specific to the pallet.
+/// An MMR specific to the pallet.
 type ModuleMmr<StorageType, T, I> = mmr::Mmr<StorageType, T, I, LeafOf<T, I>>;
 
 /// Leaf data.
@@ -381,7 +381,7 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
 		Ok(leaf_idx)
 	}
 
-	/// Generate a MMR proof for the given `block_numbers`.
+	/// Generate an MMR proof for the given `block_numbers`.
 	/// If `best_known_block_number = Some(n)`, this generates a historical proof for
 	/// the chain with head at height `n`.
 	/// Else it generates a proof for the MMR at the current block height.

frame/merkle-mountain-range/src/mmr/mmr.rs

@@ -60,7 +60,7 @@ where
 		.map_err(|e| Error::Verify.log_debug(e))
 }
 
-/// A wrapper around a MMR library to expose limited functionality.
+/// A wrapper around an MMR library to expose limited functionality.
 ///
 /// Available functions depend on the storage kind ([Runtime](crate::mmr::storage::RuntimeStorage)
 /// vs [Off-chain](crate::mmr::storage::OffchainStorage)).

frame/merkle-mountain-range/src/mmr/storage.rs

@@ -15,7 +15,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! A MMR storage implementations.
+//! An MMR storage implementation.
 
 use codec::Encode;
 use frame_support::log::{debug, error, trace};

primitives/beefy/src/mmr.rs

@@ -64,7 +64,7 @@ pub struct MmrLeaf<BlockNumber, Hash, MerkleRoot, ExtraData> {
 	pub leaf_extra: ExtraData,
 }
 
-/// A MMR leaf versioning scheme.
+/// An MMR leaf versioning scheme.
 ///
 /// Version is a single byte that constist of two components:
 /// - `major` - 3 bits

primitives/merkle-mountain-range/src/lib.rs

@@ -341,7 +341,7 @@ impl_leaf_data_for_tuple!(A:0, B:1, C:2);
 impl_leaf_data_for_tuple!(A:0, B:1, C:2, D:3);
 impl_leaf_data_for_tuple!(A:0, B:1, C:2, D:3, E:4);
 
-/// A MMR proof data for a group of leaves.
+/// An MMR proof data for a group of leaves.
 #[derive(codec::Encode, codec::Decode, RuntimeDebug, Clone, PartialEq, Eq, TypeInfo)]
 pub struct Proof<Hash> {
 	/// The indices of the leaves the proof is for.