mirror of
https://github.com/roc-lang/roc.git
synced 2025-12-23 08:48:03 +00:00
Fix some module docs
This commit is contained in:
parent
47a3801f79
commit
ef9d7426ef
13 changed files with 15 additions and 15 deletions
2
src/cache/CacheModule.zig
vendored
2
src/cache/CacheModule.zig
vendored
|
|
@ -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");
|
||||
|
|
|
|||
2
src/cache/mod.zig
vendored
2
src/cache/mod.zig
vendored
|
|
@ -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");
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
//!
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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");
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
//!
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue