diff --git a/src/cache/CacheModule.zig b/src/cache/CacheModule.zig index f54002fb9d..60c8183322 100644 --- a/src/cache/CacheModule.zig +++ b/src/cache/CacheModule.zig @@ -1,7 +1,7 @@ //! Module cache for Roc files //! //! This module provides memory-mapped caching for compiled Roc modules, -//! allowing fast serialization and deserialization of ModuleEnv data. +//! allowing fast serialization and deserialization of CIR data. const std = @import("std"); const base = @import("base"); diff --git a/src/cache/mod.zig b/src/cache/mod.zig index c0bdbed202..6cfe422d42 100644 --- a/src/cache/mod.zig +++ b/src/cache/mod.zig @@ -1,7 +1,7 @@ //! Cache module for the Roc compiler //! //! This module provides memory-mapped caching for compiled Roc modules, -//! allowing fast serialization and deserialization of ModuleEnv data. +//! allowing fast serialization and deserialization of CIR data. const std = @import("std"); diff --git a/src/check/canonicalize/Statement.zig b/src/check/canonicalize/Statement.zig index 23e37e6891..db8675dd4b 100644 --- a/src/check/canonicalize/Statement.zig +++ b/src/check/canonicalize/Statement.zig @@ -1,5 +1,5 @@ //! This module defines the `Statement` type, which represents all possible statement forms -//! in the ModuleEnv of the Roc compiler. Statements are +//! in the Canonical Intermediate Representation (CIR) of the Roc compiler. Statements are //! produced during the canonicalization phase, after parsing and semantic analysis, and //! serve as the structured, type-aware building blocks for Roc program logic. //! @@ -7,7 +7,7 @@ //! immutable and mutable declarations, reassignments, expressions, control flow constructs //! (such as `for`, `return`, and `crash`), imports, type declarations, and type annotations. //! -//! The ModuleEnv `Statement` is used both at the module top level and within block expressions, +//! The CIR `Statement` is used both at the module top level and within block expressions, //! and is designed to support robust error recovery and diagnostics, in line with Roc's //! "inform, don't block" compilation philosophy. diff --git a/src/check/canonicalize/TypeAnnotation.zig b/src/check/canonicalize/TypeAnnotation.zig index 47d9481d5c..a73a2146d1 100644 --- a/src/check/canonicalize/TypeAnnotation.zig +++ b/src/check/canonicalize/TypeAnnotation.zig @@ -1,4 +1,4 @@ -//! Representation of type annotations in the ModuleEnv. +//! Representation of type annotations in the Canonical Intermediate Representation (CIR). //! //! Includes formatting of type annotations to s-expression debug format. diff --git a/src/check/canonicalize/test/frac_test.zig b/src/check/canonicalize/test/frac_test.zig index 924d1863e5..062e8d8373 100644 --- a/src/check/canonicalize/test/frac_test.zig +++ b/src/check/canonicalize/test/frac_test.zig @@ -2,7 +2,7 @@ //! //! This module contains unit tests that verify the correct canonicalization //! of fractional literals and decimal expressions from parsed AST into the -//! compiler's canonical internal representation (ModuleEnv). +//! compiler's Canonical Intermediate Representation (CIR). const std = @import("std"); const testing = std.testing; diff --git a/src/check/canonicalize/test/int_test.zig b/src/check/canonicalize/test/int_test.zig index 1fa5227842..7b986d1266 100644 --- a/src/check/canonicalize/test/int_test.zig +++ b/src/check/canonicalize/test/int_test.zig @@ -2,7 +2,7 @@ //! //! This module contains unit tests that verify the correct canonicalization //! of integer literals and integer expressions from parsed AST into the -//! compiler's canonical internal representation (ModuleEnv). +//! compiler's Canonical Intermediate Representation (CIR). const std = @import("std"); const testing = std.testing; diff --git a/src/check/canonicalize/test/node_store_test.zig b/src/check/canonicalize/test/node_store_test.zig index 571c8bfd49..0f61b03e9e 100644 --- a/src/check/canonicalize/test/node_store_test.zig +++ b/src/check/canonicalize/test/node_store_test.zig @@ -1,4 +1,4 @@ -//! Unit tests to verify `ModuleEnv.Statement` are correctly stored in `NodeStore` +//! Unit tests to verify CIR statements are correctly stored in `NodeStore` const std = @import("std"); const testing = std.testing; diff --git a/src/check/check_types.zig b/src/check/check_types.zig index d4963b7b58..1510de6cb7 100644 --- a/src/check/check_types.zig +++ b/src/check/check_types.zig @@ -1,4 +1,4 @@ -//! Performs Hindley-Milner type inference with constraint solving and unification on the ModuleEnv representation. +//! Performs Hindley-Milner type inference with constraint solving and unification on the Canonical Intermediate Representation (CIR). //! //! This module implements constraint-based type inference. diff --git a/src/compile/Expression.zig b/src/compile/Expression.zig index c8b4b191ed..73109237c3 100644 --- a/src/compile/Expression.zig +++ b/src/compile/Expression.zig @@ -1,7 +1,7 @@ //! Expression constructs used in Roc's canonicalization phase. //! //! This module defines the `Expr` union which represents all possible expressions -//! in Roc's canonical intermediate representation (ModuleEnv). These expressions are +//! in Roc's Canonical Intermediate Representation (CIR). These expressions are //! created during the canonicalization phase and represent the semantic meaning //! of parsed code after semantic analysis. //! diff --git a/src/compile/Statement.zig b/src/compile/Statement.zig index c4468c18f4..ba307bb9c7 100644 --- a/src/compile/Statement.zig +++ b/src/compile/Statement.zig @@ -1,5 +1,5 @@ //! This module defines the `Statement` type, which represents all possible statement forms -//! in the Canonical Intermediate Representation (ModuleEnv) of the Roc compiler. Statements are +//! in the Canonical Intermediate Representation (CIR) of the Roc compiler. Statements are //! produced during the canonicalization phase, after parsing and semantic analysis, and //! serve as the structured, type-aware building blocks for Roc program logic. //! @@ -7,7 +7,7 @@ //! immutable and mutable declarations, reassignments, expressions, control flow constructs //! (such as `for`, `return`, and `crash`), imports, type declarations, and type annotations. //! -//! The ModuleEnv `Statement` is used both at the module top level and within block expressions, +//! The CIR `Statement` is used both at the module top level and within block expressions, //! and is designed to support robust error recovery and diagnostics, in line with Roc's //! "inform, don't block" compilation philosophy. diff --git a/src/compile/TypeAnnotation.zig b/src/compile/TypeAnnotation.zig index 2dbac4b68f..5ecaba2236 100644 --- a/src/compile/TypeAnnotation.zig +++ b/src/compile/TypeAnnotation.zig @@ -1,4 +1,4 @@ -//! Representation of type annotations in the ModuleEnv. +//! Representation of type annotations in the Canonical Intermediate Representation (CIR). //! //! Includes formatting of type annotations to s-expression debug format. diff --git a/src/compile/cir_types.zig b/src/compile/cir_types.zig index 88a1b3b223..c9221d39b2 100644 --- a/src/compile/cir_types.zig +++ b/src/compile/cir_types.zig @@ -1,4 +1,4 @@ -//! Common types used by CIR that need to be available in ModuleEnv +//! Common types used by the Canonical Intermediate Representation (CIR) //! These types are extracted from the canonicalize module to avoid circular dependencies const std = @import("std"); diff --git a/src/fuzz-canonicalize.zig b/src/fuzz-canonicalize.zig index 61d0733109..72dc11c418 100644 --- a/src/fuzz-canonicalize.zig +++ b/src/fuzz-canonicalize.zig @@ -1,7 +1,7 @@ //! Fuzzing for the Roc canonicalization phase //! //! This fuzzer tests the canonicalization phase of the Roc compiler, which transforms -//! the parsed AST into a ModuleEnv. The fuzzer is +//! the parsed AST into the Canonical Intermediate Representation (CIR). The fuzzer is //! designed to bias toward inputs that successfully parse and pass through canonicalization //! without errors, as these provide better code coverage for finding edge cases. //!