Add docstring for PlaceOperation

artemagvanian · Aug 17, 2024 · cc1798b · cc1798b
1 parent eb05f74
commit cc1798b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/kani-compiler/src/kani_middle/transform/check_uninit/delayed_ub/instrumentation_visitor.rs b/kani-compiler/src/kani_middle/transform/check_uninit/delayed_ub/instrumentation_visitor.rs
@@ -32,6 +32,8 @@ pub struct InstrumentationVisitor<'a, 'tcx> {
     tcx: TyCtxt<'tcx>,
 }
 
+/// This enum differentiates between different reasons to visit a place, yielding different
+/// instrumentation injected.
 enum PlaceOperation {
     Read,
     Write,