diff --git a/src/lib_scoru_wasm/wasm_pvm_sig.ml b/src/lib_scoru_wasm/wasm_pvm_sig.ml index e30cc010b419eeee61ec0dfa36b54d1326ef7f68..a58de1e57401745cc125d5f139369652cdf38615 100644 --- a/src/lib_scoru_wasm/wasm_pvm_sig.ml +++ b/src/lib_scoru_wasm/wasm_pvm_sig.ml @@ -25,13 +25,13 @@ (*****************************************************************************) open Wasm_pvm_state -(** This module type expose internals necessary for benchmarking. - - /!\ Not intended for unit tests: the functions could be used to redefine the - main execution loop, at the risk of departing from what is defined in the - PVM definition. [Internal_for_benchmark.compute_step_many_until] can use - custom stopping condition and therefore should not be used in unit test: - the test could hide regression if the condition change in the code, but not +(** This module type expose internals necessary for benchmarking. + + /!\ Not intended for unit tests: the functions could be used to redefine the + main execution loop, at the risk of departing from what is defined in the + PVM definition. [Internal_for_benchmark.compute_step_many_until] can use + custom stopping condition and therefore should not be used in unit test: + the test could hide regression if the condition change in the code, but not in the test. *) module type Internal_for_benchmark = sig open Internal_state @@ -42,14 +42,14 @@ module type Internal_for_benchmark = sig val encode : pvm_state -> tree -> tree Lwt.t - (** [compute_step_many_until_pvm_state max_step should_continue pvm_state] - advance forwards the VM in the same manners as [compute_step_many] - as long as [should_continue] returns true. - + (** [compute_step_many_until_pvm_state max_step should_continue pvm_state] + advance forwards the VM in the same manners as [compute_step_many] + as long as [should_continue] returns true. + IS applied on [pvm_state] rather than a tree. - - /!\ as it allows to redefine the stop condition, this function should - not be used in unit test: the test could hide regression if the + + /!\ as it allows to redefine the stop condition, this function should + not be used in unit test: the test could hide regression if the condition change in the code, but not in the test. *) val compute_step_many_until_pvm_state : @@ -58,12 +58,12 @@ module type Internal_for_benchmark = sig pvm_state -> pvm_state Lwt.t - (** [compute_step_many_until max_step should_continue tree] - advance forwards the VM in the same manners as [compute_step_many] - as long as [should_continue] returns true. - - /!\ as it allows to redefine the stop condition, this function should - not be used in unit test: the test could hide regression if the + (** [compute_step_many_until max_step should_continue tree] + advance forwards the VM in the same manners as [compute_step_many] + as long as [should_continue] returns true. + + /!\ as it allows to redefine the stop condition, this function should + not be used in unit test: the test could hide regression if the condition change in the code, but not in the test. *) val compute_step_many_until : diff --git a/src/lib_scoru_wasm/wasm_pvm_state.ml b/src/lib_scoru_wasm/wasm_pvm_state.ml index c20e8bf188454d979d737d4f0641d21f15a1cfcf..d494d25fbe483d40e129f238fd6b5eeac7bfc5dc 100644 --- a/src/lib_scoru_wasm/wasm_pvm_state.ml +++ b/src/lib_scoru_wasm/wasm_pvm_state.ml @@ -62,7 +62,7 @@ type info = { input_request : input_request; (** The current VM input request. *) } -(** This module type defines the state for the PVM. +(** This module type defines the state for the PVM. For use in lib_scoru_wasm only. *) module Internal_state = struct type tick_state =