Mirrors/wrkflw
1
0
Fork 0
mirror of https://github.com/bahdotsh/wrkflw.git synced 2025-12-16 11:47:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(utils): update README to document cross-platform fd behavior

Browse Source 
- Document Unix vs Windows fd redirection limitations
- Update example to reflect platform-specific behavior
- Clarify that stderr suppression is Unix-only
This commit is contained in:
bahdotsh
2025-08-27 15:36:51 +05:30
parent dff3697052
commit aa9da33b30
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/utils/README.md
View File

@@ -3,7 +3,7 @@
Shared helpers used across crates.
- Workflow file detection (`.github/workflows/*.yml`, `.gitlab-ci.yml`)
- File-descriptor redirection utilities for silencing noisy subprocess output
- File-descriptor redirection utilities for silencing noisy subprocess output (Unix only; Windows support is limited)
### Example
@@ -14,7 +14,7 @@ use wrkflw_utils::{is_workflow_file, fd::with_stderr_to_null};
assert!(is_workflow_file(Path::new(".github/workflows/ci.yml")));
let value = with_stderr_to_null(|| {
eprintln!("this is hidden");
eprintln!("this is hidden on Unix, visible on Windows");
42
}).unwrap();
assert_eq!(value, 42);