Skip to content

Commit 6892359

Browse files
committed
Normalize docs
1 parent 430f7c1 commit 6892359

File tree

2 files changed

+17
-19
lines changed

2 files changed

+17
-19
lines changed

src/process.rs

+8-8
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,6 @@ impl Duplex {
150150
/// avoid deadlock: it ensures that the child does not block waiting for input from the parent,
151151
/// while the parent waits for the child to exit.
152152
///
153-
/// # Errors
154-
///
155-
/// Relays the error from [`std::process::Child::wait()`]
156-
///
157153
/// # Examples
158154
///
159155
/// Basic usage:
@@ -175,6 +171,10 @@ impl Duplex {
175171
/// reader.read_to_string(&mut buffer).unwrap();
176172
/// }
177173
/// ```
174+
///
175+
/// # Errors
176+
///
177+
/// Relays the error from [`std::process::Child::wait()`]
178178
pub fn wait(
179179
self,
180180
) -> Result<
@@ -371,10 +371,6 @@ impl Simplex {
371371
/// avoid deadlock: it ensures that the child does not block waiting for input from the parent,
372372
/// while the parent waits for the child to exit.
373373
///
374-
/// # Errors
375-
///
376-
/// Relays the error from [`std::process::Child::wait()`]
377-
///
378374
/// # Examples
379375
///
380376
/// Basic usage:
@@ -398,6 +394,10 @@ impl Simplex {
398394
/// let mut reader = BufReader::new(output);
399395
/// reader.read_to_string(&mut buffer).unwrap();
400396
/// ```
397+
///
398+
/// # Errors
399+
///
400+
/// Relays the error from [`std::process::Child::wait()`]
401401
pub fn wait(self) -> Result<std::process::ExitStatus, std::io::Error> {
402402
let (mut child, _) = self.eject();
403403
child.wait()

src/tokio.rs

+9-11
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,6 @@ impl Duplex {
187187
/// avoid deadlock: it ensures that the child does not block waiting for input from the parent,
188188
/// while the parent waits for the child to exit.
189189
///
190-
/// # Errors
191-
///
192-
/// Relays the error from [`tokio::process::Child::wait()`]
193-
///
194190
/// # Examples
195191
///
196192
/// Basic usage:
@@ -214,6 +210,10 @@ impl Duplex {
214210
/// }
215211
/// # };
216212
/// ```
213+
///
214+
/// # Errors
215+
///
216+
/// Relays the error from [`tokio::process::Child::wait()`]
217217
pub async fn wait(
218218
self,
219219
) -> Result<
@@ -460,10 +460,6 @@ impl Simplex {
460460
/// avoid deadlock: it ensures that the child does not block waiting for input from the parent,
461461
/// while the parent waits for the child to exit.
462462
///
463-
/// # Errors
464-
///
465-
/// Relays the error from [`tokio::process::Child::wait()`]
466-
///
467463
/// # Examples
468464
///
469465
/// Basic usage:
@@ -489,6 +485,10 @@ impl Simplex {
489485
/// reader.read_to_string(&mut buffer).await.unwrap();
490486
/// # };
491487
/// ```
488+
///
489+
/// # Errors
490+
///
491+
/// Relays the error from [`tokio::process::Child::wait()`]
492492
pub async fn wait(self) -> Result<std::process::ExitStatus, std::io::Error> {
493493
let (mut child, _) = self.eject();
494494
child.wait().await
@@ -546,9 +546,7 @@ impl Simplex {
546546
///
547547
/// # Errors
548548
///
549-
/// * [`std::io::Error`] if failure when killing the process.
550-
///
551-
/// [`std::io::Error`]: std::io::Error
549+
/// If failure when killing the process.
552550
pub async fn shutdown(mut self) -> std::io::Result<std::process::ExitStatus> {
553551
match self
554552
.0

0 commit comments

Comments
 (0)