Improve code and documentation consistency (#6918)

starkware-libs · Dec 26, 2024 · 794953c · 794953c
1 parent 190d1e2
commit 794953c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/crates/bin/get-lowering/src/main.rs b/crates/bin/get-lowering/src/main.rs
@@ -69,7 +69,7 @@ struct Args {
     #[arg(short, long)]
     single_file: bool,
 
-    /// whenever to print all lowering stages or only the final lowering.
+    /// whether to print all lowering stages or only the final lowering.
     #[arg(short, long)]
     all: bool,
 

diff --git a/crates/cairo-lang-lowering/src/optimizations/test_data/cancel_ops b/crates/cairo-lang-lowering/src/optimizations/test_data/cancel_ops
@@ -179,7 +179,7 @@ fn foo(a: felt252) -> felt252 {
         let (a, _arr) = c;
         return a;
     } else {
-        cosume(c);
+        consume(c);
         return 1;
     }
 }
@@ -188,7 +188,7 @@ fn foo(a: felt252) -> felt252 {
 foo
 
 //! > module_code
-extern fn cosume(arg: (felt252, Array<felt252>)) nopanic;
+extern fn consume(arg: (felt252, Array<felt252>)) nopanic;
 
 //! > semantic_diagnostics
 
@@ -242,7 +242,7 @@ End:
 
 blk4:
 Statements:
-  () <- test::cosume(v11)
+  () <- test::consume(v11)
   (v28: core::felt252) <- 1
 End:
   Return(v28)
@@ -297,7 +297,7 @@ End:
 
 blk4:
 Statements:
-  () <- test::cosume(v11)
+  () <- test::consume(v11)
   (v28: core::felt252) <- 1
 End:
   Return(v28)

diff --git a/crates/cairo-lang-lowering/src/optimizations/test_data/split_structs b/crates/cairo-lang-lowering/src/optimizations/test_data/split_structs
@@ -135,7 +135,7 @@ fn foo(a: felt252) -> felt252 {
         let (a, _arr) = c;
         return a;
     } else {
-        cosume(c);
+        consume(c);
         return 1;
     }
 }
@@ -144,7 +144,7 @@ fn foo(a: felt252) -> felt252 {
 foo
 
 //! > module_code
-extern fn cosume(arg: (felt252, Array<felt252>)) nopanic;
+extern fn consume(arg: (felt252, Array<felt252>)) nopanic;
 
 //! > semantic_diagnostics
 
@@ -198,7 +198,7 @@ End:
 
 blk4:
 Statements:
-  () <- test::cosume(v11)
+  () <- test::consume(v11)
   (v28: core::felt252) <- 1
 End:
   Return(v28)
@@ -257,7 +257,7 @@ End:
 blk4:
 Statements:
   (v31: (core::felt252, core::array::Array::<core::felt252>)) <- struct_construct(v0, v9)
-  () <- test::cosume(v31)
+  () <- test::consume(v31)
   (v28: core::felt252) <- 1
 End:
   Return(v28)

diff --git a/docs/reference/readme.md b/docs/reference/readme.md
@@ -22,7 +22,7 @@ apt-get install asciidoctor
 ```
 
 ### Convert to HTML
-> Tips:`pwd` is `cairo/docs/reference`
+> Tip:`pwd` is `cairo/docs/reference`
 
 - Convert a single file
 ```bash
@@ -51,7 +51,7 @@ apt-get install asciidoctor
 ```
 
 ### Convert to PDF
-> Tips: `pwd` is `cairo/docs/reference`
+> Tip: `pwd` is `cairo/docs/reference`
 
 - Convert a single file
 ```bash