github/ere
1
1
Fork 0
mirror of https://github.com/eth-act/ere.git synced 2026-02-19 11:54:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: improve the docs of macro export_cycle_scope_names

Browse Source 
Co-authored-by: jsign <jsign.uy@gmail.com>
This commit is contained in:
han0110
2026-02-08 14:16:19 +00:00
parent 25612458ee
commit 11baba072d
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/zkvm/zisk/platform/src/lib.rs
View File

@@ -199,11 +199,13 @@ pub fn check_cycle_scope_names(_names: &[&str]) {
/// Exports cycle scope names as symbols for `ziskemu` to display human-readable names.
///
/// Names must be listed in the same order as they were first used via
/// [`Platform::cycle_scope_start`].
/// The declared scope names must be declared in the order they are _executed_
/// in your code. Not doing so can dangerously name a scope incorrectly. Be
/// careful if you have lambda functions or conditionals since it is easy to
/// confuse the right order.
///
/// Enable feature `check-cycle-scope` to verify correctness at runtime
/// (panics on mismatch with expected output to copy-paste).
/// automatically (panics on mismatch with expected output to copy-paste).
#[macro_export]
macro_rules! export_cycle_scope_names {
($($name:ident),* $(,)?) => {{