Skip to content

Commit

Permalink
doc: fix too_long_first_doc_paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
AsakuraMizu committed Aug 26, 2024
1 parent 88cfb5c commit eb55686
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions compio-driver/src/op.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//! The async operations.
//!
//! Types in this mod represents the low-level operations passed to kernel.
//! The operation itself doesn't perform anything.
//! You need to pass them to [`crate::Proactor`], and poll the driver.
Expand Down
7 changes: 4 additions & 3 deletions compio-io/src/compat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ use pin_project_lite::pin_project;
use crate::{buffer::Buffer, util::DEFAULT_BUF_SIZE};

/// A wrapper for [`AsyncRead`](crate::AsyncRead) +
/// [`AsyncWrite`](crate::AsyncWrite), providing sync traits impl. The sync
/// methods will return [`io::ErrorKind::WouldBlock`] error if the inner buffer
/// needs more data.
/// [`AsyncWrite`](crate::AsyncWrite), providing sync traits impl.
///
/// The sync methods will return [`io::ErrorKind::WouldBlock`] error if the
/// inner buffer needs more data.
#[derive(Debug)]
pub struct SyncStream<S> {
stream: S,
Expand Down

0 comments on commit eb55686

Please sign in to comment.