Add to docs

avsaase · avsaase · commit 9bf91f16d71e · 2024-07-19T21:13:47.000+02:00
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>;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,10 @@ pub trait ReadNorFlash: ErrorType {`
`19`	`19`	`async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>;`
`20`	`20`
`21`	`21`	`/// The capacity of the peripheral in bytes.`
	`22`	`+ ///`
	`23`	`+ /// # Errors`
	`24`	`+ ///`
	`25`	`+ /// Returns an error if the IO operation fails.`
`22`	`26`	`async fn capacity(&self) -> Result<usize, Self::Error>;`
`23`	`27`	`}`
`24`	`28`