soenkehahn / cradle

Rust library for running child processes
Creative Commons Zero v1.0 Universal
38 stars 5 forks source link

Switch main documentation to `Input::run...` methods? #171

Open soenkehahn opened 3 years ago

soenkehahn commented 3 years ago

Currently the main documentation (in the root module) is using the macros run!, run_output! and run_result!. It mentions the Input::run... methods under a section called Alternative Interface. We could switch that and have the Input::run... methods be the main interface in the documentation. I'm not sure whether that'd be better though. Any opinions?