Skip to content

Commit 11b4672

Browse files
fix(raz-override): fix doctest failure in README
- Add missing imports and variable definitions - Make the example a complete, runnable code snippet - Use doc comment syntax (#) to hide boilerplate from docs
1 parent 372f544 commit 11b4672

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

raz-override/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,28 @@ The override system implements a deferred save pattern - overrides are only pers
4646
```rust
4747
use raz_override::{SmartOverrideParser, OverrideSystem};
4848
use raz_config::CommandOverride;
49+
use std::path::Path;
4950

51+
# fn main() -> Result<(), Box<dyn std::error::Error>> {
5052
// Parse runtime overrides
5153
let parser = SmartOverrideParser::new("test");
5254
let overrides = parser.parse("RUST_BACKTRACE=full --release -- --exact");
5355

5456
// Create override system for workspace
57+
let workspace_path = Path::new(".");
5558
let mut override_system = OverrideSystem::new(&workspace_path)?;
5659

5760
// Get function context and save override (deferred save pattern)
61+
let file_path = Path::new("src/lib.rs");
5862
let function_context = override_system.get_function_context(file_path, 24, Some(0))?;
5963
let override_key = override_system.generate_key(&function_context)?;
6064

65+
// Create a command override
66+
let mut command_override = CommandOverride::new("cargo".to_string());
67+
command_override.cargo_options.push("--release".to_string());
68+
6169
// Only save after successful execution
70+
let command_succeeded = true; // Set based on actual command execution
6271
if command_succeeded {
6372
override_system.save_override_with_validation(
6473
override_key,
@@ -67,6 +76,8 @@ if command_succeeded {
6776
"test"
6877
)?;
6978
}
79+
# Ok(())
80+
# }
7081
```
7182

7283
## Library API

0 commit comments

Comments
 (0)