update documentation

master-hax · master-hax · commit e5d2e2de6d9b · 2025-08-05T20:26:30.000-07:00
diff --git a/embedded-io-async/src/impls/slice_mut.rs b/embedded-io-async/src/impls/slice_mut.rs
@@ -26,7 +26,7 @@ impl Write for &mut [u8] {
     }
 }
 
-/// Write is implemented for `&mut [u8]` by copying into the slice, overwriting
+/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, initializing & overwriting
 /// its data.
 ///
 /// Note that writing updates the slice to point to the yet unwritten part.
diff --git a/embedded-io/src/impls/slice_mut.rs b/embedded-io/src/impls/slice_mut.rs
@@ -59,7 +59,7 @@ impl ErrorType for &mut [MaybeUninit<u8>] {
     type Error = SliceWriteError;
 }
 
-/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, overwriting
+/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, initializing & overwriting
 /// its data.
 ///
 /// Note that writing updates the slice to point to the yet unwritten part.

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ impl Write for &mut [u8] {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		-/// Write is implemented for `&mut [u8]` by copying into the slice, overwriting
	`29`	+/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, initializing & overwriting
`30`	`30`	`/// its data.`
`31`	`31`	`///`
`32`	`32`	`/// Note that writing updates the slice to point to the yet unwritten part.`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ impl ErrorType for &mut [MaybeUninit<u8>] {`
`59`	`59`	`type Error = SliceWriteError;`
`60`	`60`	`}`
`61`	`61`
`62`		-/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, overwriting
	`62`	+/// Write is implemented for `&mut [MaybeUninit<u8>]` by copying into the slice, initializing & overwriting
`63`	`63`	`/// its data.`
`64`	`64`	`///`
`65`	`65`	`/// Note that writing updates the slice to point to the yet unwritten part.`