chore: fix grammatical errors and improve clarity in code (#8959)

Signed-off-by: xiaolinny <[email protected]>

Author: xiaolinny

corelib/src/test/print_test.cairo

@@ -78,9 +78,9 @@ fn test_prints() {
     x.append(@suffix);
     print_byte_array_as_string(@x);
 
-    // Valid string with a non printable character.
+    // Valid string with a non-printable character.
     let mut x: ByteArray = "Hello";
-    x.append_byte(0x11); // Non printable character.
+    x.append_byte(0x11); // Non-printable character.
     let suffix: ByteArray = "world";
     x.append(@suffix);
     print_byte_array_as_string(@x);

crates/cairo-lang-defs/src/ids.rs

@@ -942,7 +942,7 @@ impl<'db> GenericItemId<'db> {
                         // `parent1.parent()` is safe.
                         let parent0_ptr = SyntaxStablePtrId(parent0);
                         match parent1.parent(db).map(|p| p.kind(db)) {
-                            // SyntaxFile is root level (file level)
+                            // SyntaxFile is root level (file-level)
                             Some(SyntaxKind::SyntaxFile) | Some(SyntaxKind::ModuleBody) => {
                                 GenericItemId::ModuleItem(GenericModuleItemId::FreeFunc(
                                     FreeFunctionLongId(

crates/cairo-lang-filesystem/src/span.rs

@@ -12,8 +12,8 @@ use crate::ids::FileId;
 #[path = "span_test.rs"]
 mod test;
 
-/// Byte length of an utf8 string.
-// This wrapper type is used to avoid confusion with non-utf8 sizes.
+/// Byte length of a UTF-8 string.
+// This wrapper type is used to avoid confusion with non-UTF-8 sizes.
 #[derive(
     Copy,
     Clone,
@@ -82,7 +82,7 @@ impl Sum for TextWidth {
     }
 }
 
-/// Byte offset inside a utf8 string.
+/// Byte offset inside a UTF-8 string.
 #[derive(
     Copy,
     Clone,
@@ -274,7 +274,7 @@ pub struct FileSummary {
     pub last_offset: TextOffset,
 }
 impl FileSummary {
-    /// Gets the number of lines
+    /// Gets the number of lines.
     pub fn line_count(&self) -> usize {
         self.line_offsets.len()
     }

crates/cairo-lang-lowering/src/db.rs

@@ -155,7 +155,7 @@ pub trait LoweringGroup: Database {
         module_lowering_diagnostics(self.as_dyn_database(), (), module_id)
     }
 
-    /// Aggregates file level lowering diagnostics.
+    /// Aggregates file-level lowering diagnostics.
     fn file_lowering_diagnostics<'db>(
         &'db self,
         file_id: FileId<'db>,

crates/cairo-lang-runner/src/casm_run/test.rs

@@ -199,7 +199,7 @@ fn test_as_cairo_short_string() {
     assert_eq!(as_cairo_short_string(&Felt252::from(0x6100)), Some("a".to_string()));
     assert_eq!(as_cairo_short_string(&Felt252::from(0x61000000)), Some("a".to_string()));
 
-    // With a non printable character.
+    // With a non-printable character.
     assert_eq!(as_cairo_short_string(&Felt252::from(0x610162)), None);
 }
 
@@ -226,7 +226,7 @@ fn test_as_cairo_short_string_ex() {
     assert_eq!(as_cairo_short_string_ex(&Felt252::from(0x6100), 2), Some(r"a\0".to_string()));
     assert_eq!(as_cairo_short_string_ex(&Felt252::from(0x610062), 3), Some(r"a\0b".to_string()));
 
-    // With a non printable character.
+    // With a non-printable character.
     assert_eq!(as_cairo_short_string_ex(&Felt252::from(0x610162), 3), Some(r"a\x01b".to_string()));
 
     // More data than expected.
@@ -406,7 +406,7 @@ fn test_format_for_debug() {
     // Valid string with Null.
     let felts = vec![
         Felt252::from_hex_unchecked(BYTE_ARRAY_MAGIC),
-        // No full word.
+        // No full words.
         Felt252::from(0),
         // pending word: 'Hello\0world'
         Felt252::from_hex_unchecked("48656c6c6f00776f726c64"),
@@ -418,7 +418,7 @@ fn test_format_for_debug() {
     // Valid string with a non printable character.
     let felts = vec![
         Felt252::from_hex_unchecked(BYTE_ARRAY_MAGIC),
-        // No full word.
+        // No full words.
         Felt252::from(0),
         // pending word: 'Hello\x11world'
         Felt252::from_hex_unchecked("48656c6c6f11776f726c64"),
@@ -430,7 +430,7 @@ fn test_format_for_debug() {
     // Valid string with a newline.
     let felts = vec![
         Felt252::from_hex_unchecked(BYTE_ARRAY_MAGIC),
-        // No full word.
+        // No full words.
         Felt252::from(0),
         // pending word: 'Hello\nworld'
         Felt252::from_hex_unchecked("48656c6c6f0a776f726c64"),

crates/cairo-lang-semantic/src/db.rs

@@ -98,7 +98,7 @@ pub trait SemanticGroup: Database {
         module_semantic_diagnostics_tracked(self.as_dyn_database(), (), module_id)
     }
 
-    /// Aggregates file level semantic diagnostics.
+    /// Aggregates file-level semantic diagnostics.
     fn file_semantic_diagnostics<'db>(
         &'db self,
         file_id: FileId<'db>,

crates/cairo-lang-starknet-classes/src/contract_segmentation.rs

@@ -154,7 +154,7 @@ impl FunctionInfo {
         Ok(())
     }
 
-    /// Visits a statement inside the function and update the [FunctionInfo] accordingly.
+    /// Visits a statement inside the function and updates the [FunctionInfo] accordingly.
     fn visit_statement(
         &mut self,
         idx: usize,

crates/cairo-lang-test-runner/src/lib.rs

@@ -269,7 +269,7 @@ impl<'db> TestCompiler<'db> {
 /// # Arguments
 /// * `compiled` - Compiled test cases with metadata.
 /// * `include_ignored` - Include ignored tests as well.
-/// * `ignored` - Run ignored tests only.l
+/// * `ignored` - Run ignored tests only
 /// * `filter` - Include only tests containing the filter string.
 /// # Returns
 /// * (`TestCompilation`, `usize`) - The filtered test cases and the number of filtered out cases.
@@ -303,13 +303,13 @@ pub fn filter_test_cases<'db>(
     (tests, filtered_out)
 }
 
-/// The status of a ran test.
+/// The status of a test run.
 enum TestStatus {
     Success,
     Fail(RunResultValue),
 }
 
-/// The result of a ran test.
+/// The result of a test run.
 struct TestResult {
     /// The status of the run.
     status: TestStatus,
@@ -321,15 +321,15 @@ struct TestResult {
     profiling_info: Option<ProfilingInfo>,
 }
 
-/// Summary data of the ran tests.
+/// Summary data of the tests run.
 pub struct TestsSummary {
     passed: Vec<String>,
     failed: Vec<String>,
     ignored: Vec<String>,
     failed_run_results: Vec<Result<RunResultValue>>,
 }
 
-/// Runs the tests and process the results for a summary.
+/// Runs the tests and processes the results for a summary.
 pub fn run_tests(
     opt_db: Option<&dyn Database>,
     compiled: TestCompilation<'_>,

crates/cairo-lang-test-runner/src/test.rs

@@ -186,7 +186,7 @@ fn test_format_for_panic() {
     ];
     assert_eq!(format_for_panic(felts.into_iter()), "Panicked with \"Hello\\0world\".");
 
-    // Valid string with a non printable character.
+    // Valid string with a non-printable character.
     let felts = vec![
         Felt252::from_hex_unchecked(BYTE_ARRAY_MAGIC),
         // No full word.