Skip to content

Commit 7afe36f

Browse files
committed
Improve Effects documentation
1 parent bae9c07 commit 7afe36f

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

zjit/src/hir_effect/mod.rs

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ include!("hir_effect.inc.rs");
66

77
// NOTE: Effect very intentionally does not support Eq or PartialEq; we almost never want to check
88
// bit equality of types in the compiler but instead check subtyping, intersection, union, etc.
9-
/// The main work horse of effect inference and specialization. The main interfaces
9+
/// The AbstractHeap struct is the main work horse of effect inference and specialization. The main interfaces
1010
/// will look like:
1111
///
12-
/// * is effect A a subset of effect B
13-
/// * union/meet effect A and effect B
12+
/// * is AbstractHeap A a subset of AbstractHeap B
13+
/// * union/meet AbstractHeap A and AbstractHeap B
14+
///
15+
/// or
16+
///
17+
/// * is Effect A a subset of Effect B
18+
/// * union/meet Effect A and Effect B
19+
///
20+
/// The AbstractHeap is the work horse because Effect is simply 2 AbstractHeaps; one for read, and one for write.
1421
///
1522
/// Most questions can be rewritten in terms of these operations.
1623
///

0 commit comments

Comments
 (0)