docs: add some details on collect_raw_walltime_results

art049 · art049 · commit 95b1ea68cf5a · 2025-02-06T10:49:49.000+01:00
diff --git a/crates/codspeed/src/walltime.rs b/crates/codspeed/src/walltime.rs
@@ -48,6 +48,8 @@ impl RawWallTimeData {
 }
 
 /// Entry point called in patched integration to harvest raw walltime data
+///
+/// `CODSPEED_CARGO_WORKSPACE_ROOT` is expected to be set for this to work
 pub fn collect_raw_walltime_results(
     scope: &str,
     name: String,

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,8 @@ impl RawWallTimeData {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/// Entry point called in patched integration to harvest raw walltime data`
	`51`	`+///`
	`52`	+/// `CODSPEED_CARGO_WORKSPACE_ROOT` is expected to be set for this to work
`51`	`53`	`pub fn collect_raw_walltime_results(`
`52`	`54`	`scope: &str,`
`53`	`55`	`name: String,`