diff --git a/common/canonical_serialization/src/canonical_serialization_test.rs b/common/canonical_serialization/src/canonical_serialization_test.rs index c44a830f458d..f7528b9de98d 100644 --- a/common/canonical_serialization/src/canonical_serialization_test.rs +++ b/common/canonical_serialization/src/canonical_serialization_test.rs @@ -19,9 +19,9 @@ const TEST_VECTOR_1: &str = "ffffffffffffffff060000006463584d4237640000000000000 // Why do we need test vectors? // -// 1. Sometimes it help to catch common bugs between serialization and +// 1. Sometimes it helps to catch common bugs between serialization and // deserialization functions that would have been missed by a simple round trip test. -// For example, if there's a bug in a shared procedure that serialize and +// For example, if there's a bug in a shared procedure that serializes and // deserialize both calls then roundtrip might miss it. // // 2. It helps to catch code changes that inadvertently introduce breaking changes diff --git a/common/canonical_serialization/src/lib.rs b/common/canonical_serialization/src/lib.rs index 612e3471e802..661bb671c644 100644 --- a/common/canonical_serialization/src/lib.rs +++ b/common/canonical_serialization/src/lib.rs @@ -15,7 +15,7 @@ //! //! An extremely simple implementation of CanonicalSerializer is also provided, the encoding //! rules are: -//! (All unsigned integers are encoded in little endian representation unless specified otherwise) +//! (All unsigned integers are encoded in little-endian representation unless specified otherwise) //! //! 1. The encoding of an unsigned 64-bit integer is defined as its little endian representation //! in 8 bytes @@ -29,7 +29,7 @@ //! [No. of items in the list, represented as 4-byte integer] || encoding(item_0) || .... //! //! 4. The encoding of an ordered map where the keys are ordered by lexicographic order. -//! Currently we only support key and value of type Vec. The encoding is defined as: +//! Currently, we only support key and value of type Vec. The encoding is defined as: //! [No. of key value pairs in the map, represented as 4-byte integer] || encode(key1) || //! encode(value1) || encode(key2) || encode(value2)... //! where the pairs are appended following the lexicographic order of the key