Skip to content

Commit 6a39e62

Browse files
committed
add remaining docs (#450)
1 parent 8c61b0b commit 6a39e62

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

git-command/src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
#![deny(rust_2018_idioms)]
1+
//! Launch commands very similarly to `std::process::Command`, but with `git` specific capabilities and adjustments.
2+
#![deny(rust_2018_idioms, missing_docs)]
23
#![forbid(unsafe_code)]
34

45
use std::ffi::OsString;
56

7+
/// A structure to keep settings to use when invoking a command via [`spawn()`][Prepare::spawn()], after creating it with [`prepare()`].
68
pub struct Prepare {
79
command: OsString,
810
stdin: std::process::Stdio,
@@ -45,6 +47,7 @@ mod prepare {
4547

4648
/// Finalization
4749
impl Prepare {
50+
/// Spawn the command as configured.
4851
pub fn spawn(self) -> std::io::Result<std::process::Child> {
4952
let mut cmd = if self.use_shell {
5053
let mut cmd = std::process::Command::new(if cfg!(windows) { "sh" } else { "/bin/sh" });

0 commit comments

Comments
 (0)