Add to docs

rust-embedded-community · Jul 19, 2024 · 9bf91f1 · 9bf91f1
1 parent 1a86e28
commit 9bf91f1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/embedded-storage-async/src/nor_flash.rs b/embedded-storage-async/src/nor_flash.rs
@@ -19,6 +19,10 @@ pub trait ReadNorFlash: ErrorType {
 	async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>;
 
 	/// The capacity of the peripheral in bytes.
+	///
+	/// # Errors
+	///
+	/// Returns an error if the IO operation fails.
 	async fn capacity(&self) -> Result<usize, Self::Error>;
 }