Apply suggestions from code review

Co-authored-by: Diego Barrios Romero <[email protected]>
rust-embedded · Jul 12, 2023 · efdccc2 · efdccc2
1 parent 5df51e5
commit efdccc2
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/embedded-io/CHANGELOG.md b/embedded-io/CHANGELOG.md
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-- Added `ReadReady`, `WriteReady` traits. They allow peeking whether the i/o handle is ready to read/write, so they allow using the traits in a non-blocking way.
+- Added `ReadReady`, `WriteReady` traits. They allow peeking whether the I/O handle is ready to read/write, so they allow using the traits in a non-blocking way.
 - Moved `embedded_io::blocking` to the crate root.
 - Split async traits to the `embedded-io-async` crate.
 - Split async trait adapters to separate crates.

diff --git a/embedded-io/README.md b/embedded-io/README.md
@@ -6,7 +6,7 @@
 
 This project is developed and maintained by the [HAL team](https://github.com/rust-embedded/wg#the-hal-team).
 
-IO traits for embedded systems.
+Input/Output traits for embedded systems.
 
 Rust's `std::io` traits are not available in `no_std` targets, mainly because `std::io::Error`
 requires allocation. This crate contains replacement equivalent traits, usable in `no_std`

diff --git a/embedded-io/src/adapters.rs b/embedded-io/src/adapters.rs
@@ -3,9 +3,9 @@
 //! To interoperate with `std::io`, wrap a type in one of these
 //! adapters.
 //!
-//! There's no separate adapters for Read/ReadBuf/Write traits. Instead, a single
+//! There are no separate adapters for `Read`/`ReadBuf`/`Write` traits. Instead, a single
 //! adapter implements the right traits based on what the inner type implements.
-//! This allows adapting a `Read+Write`, for example.
+//! This allows using these adapters when using `Read+Write`, for example.
 
 use crate::SeekFrom;
 

diff --git a/embedded-io/src/lib.rs b/embedded-io/src/lib.rs
@@ -281,7 +281,7 @@ pub trait ReadReady: crate::Io {
 /// This allows using a [`Write`] in a nonblocking fashion, i.e. trying to write
 /// only when it is ready.
 pub trait WriteReady: crate::Io {
-    /// Get whether the writer is ready for immediately writeing.
+    /// Get whether the writer is ready for immediately writing.
     ///
     /// This usually means that there is free space in the internal transmit buffer.
     ///