Merge #550

550: Some API documentation fixes in traits r=Dirbaio a=lulf



Co-authored-by: Ulf Lilleengen <[email protected]>

1 files changed, 2 insertions, 0 deletions

diff --git a/embassy-traits/src/uart.rs b/embassy-traits/src/uart.rs
index 755aee6d3..4984bc89c 100644
--- a/embassy-traits/src/uart.rs
+++ b/embassy-traits/src/uart.rs
@@ -12,6 +12,7 @@ pub trait Read {
     where
         Self: 'a;
 
+    /// Receive into the buffer until the buffer is full.
     fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Self::ReadFuture<'a>;
 }
 
@@ -30,5 +31,6 @@ pub trait Write {
     where
         Self: 'a;
 
+    /// Write all bytes in `buf`.
     fn write<'a>(&'a mut self, buf: &'a [u8]) -> Self::WriteFuture<'a>;
 }