Skip to content

Commit

Permalink
wip: last doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
passcod committed Mar 11, 2024
1 parent ea631f5 commit 2b6b7bd
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
5 changes: 5 additions & 0 deletions src/generic_wrap.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#![cfg_attr(
not(any(feature = "std", feature = "tokio1")),
allow(unused_macros, unused_imports)
)]

macro_rules! Wrap {
($name:ident, $command:ty, $wrapper:ident, $child:ty, $childer:ident, $first_child_wrapper:expr) => {
/// A wrapper around a `Command` that allows for additional functionality to be added.
Expand Down
2 changes: 1 addition & 1 deletion src/std.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//! ```
#[doc(inline)]
pub use core::{StdChildWrapper, StdCommandWrap, StdCommandWrapper};
pub use core::{StdChild, StdChildWrapper, StdCommandWrap, StdCommandWrapper};
#[cfg(all(windows, feature = "creation-flags"))]
#[doc(inline)]
pub use creation_flags::CreationFlags;
Expand Down
6 changes: 5 additions & 1 deletion src/std/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,11 @@ pub trait StdChildWrapper: std::fmt::Debug + Send + Sync {
}
}

// can't impl directly on Child as it would cause loops
/// A thin wrapper around [`Child`].
///
/// This is used only because implementing [`StdChildWrapper`] directly on std's [`Child`] creates
/// loops in the type system. It is not intended to be used directly, but only to be used internally
/// by the library.
#[derive(Debug)]
pub struct StdChild(pub Child);

Expand Down

0 comments on commit 2b6b7bd

Please sign in to comment.