Skip to content

Commit 3cbae88

Browse files
Improve documentation on hook API
1 parent 513bf4b commit 3cbae88

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

vm/src/vm/runners/cairo_runner.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,6 +1093,9 @@ impl CairoRunner {
10931093
/// To make the hints clonable (and cacheable), the hint data type had to
10941094
/// be changed. To avoid breaking the API, new v2 functions were added that
10951095
/// accept the new hint data.
1096+
///
1097+
/// Also, this new function does not call instruction hooks from the
1098+
/// `test_utils` features, as doing so would imply breaking the hook API.
10961099
pub fn run_until_pc_v2(
10971100
&mut self,
10981101
address: Relocatable,

vm/src/vm/vm_core.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,9 @@ impl VirtualMachine {
695695
/// [CairoRunner::run_until_pc_v2] for documentation on why the signature
696696
/// had to be changed.
697697
///
698+
/// Also, this new function does not call step hooks from the
699+
/// `test_utils` features, as doing so would imply breaking the hook API.
700+
///
698701
/// [CairoRunner::run_until_pc_v2]: crate::vm::runners::cairo_runner::CairoRunner::run_until_pc_v2
699702
pub fn step_v2(
700703
&mut self,

0 commit comments

Comments
 (0)