update readme for snd & fs

boozook · Sep 28, 2023 · e6c1ae8 · e6c1ae8
1 parent c50884b
commit e6c1ae8
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 27 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/api/fs/Cargo.toml b/api/fs/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "playdate-fs"
-version = "0.2.0"
+version = "0.2.1"
 readme = "README.md"
 description = "High-level file-system API built on-top of Playdate API"
 keywords = ["playdate", "sdk", "api", "gamedev"]

diff --git a/api/fs/README.md b/api/fs/README.md
@@ -2,7 +2,7 @@
 
 High-level interface to file-system on-top of `playdate-sys` crate.
 
-⚠️ Until the version `0.3` API is unstable and can be changed partially.
+⚠️ Prior to the version `0.3` API is unstable and can be changed without deprecation period.
 
 
 

diff --git a/api/sound/Cargo.toml b/api/sound/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "playdate-sound"
-version = "0.2.2"
+version = "0.2.3"
 readme = "README.md"
 description = "High-level sound API built on-top of Playdate API"
 keywords = ["playdate", "sdk", "api", "gamedev"]

diff --git a/api/sound/README.md b/api/sound/README.md
@@ -2,14 +2,12 @@
 
 High-level sound API built on-top of [playdate-sys][].
 
-Covered parts the sound API:
+Covered parts of the sound API:
 - File Player
 - Sample Player
   - Sample
 - Sound Source
-- Headphones and microphone (incomplete) 🤏
-
-⚠️ __Incomplete__, WiP.
+- Headphones and microphone (incomplete)
 
 Not covered things:
 - channel
@@ -20,7 +18,7 @@ Not covered things:
 - envelope
 - callbacks
 
-Before the version `0.3` API is unstable and can be changed.
+⚠️ Prior to the version `0.3` API is unstable and can be changed without deprecation period.
 
 
 ## Prerequisites
@@ -33,6 +31,7 @@ Before the version `0.3` API is unstable and can be changed.
 [sdk]: https://play.date/dev/#cardSDK
 [doc-prerequisites]: https://sdk.play.date/Inside%20Playdate%20with%20C.html#_prerequisites
 
+
 ## Usage
 
 ```rust

diff --git a/api/sound/src/sample.rs b/api/sound/src/sample.rs
@@ -102,15 +102,7 @@ impl<Api: api::Api> Sample<Api> {
 	pub fn new_for_file_with<P: AsRef<Path>>(api: Api, path: P) -> Result<Self, ApiError> {
 		let size = match fs::metadata(path) {
 			Ok(stats) => stats.size,
-			Err(err) => {
-				return match err {
-					fs::error::ApiError::Api(err) => Err(ApiError::Api(err.into())),
-					fs::error::ApiError::Utf8(err) => Err(ApiError::Utf8(err)),
-					fs::error::ApiError::FromUtf8(err) => Err(ApiError::FromUtf8(err)),
-					fs::error::ApiError::CStr(err) => Err(ApiError::CStr(err)),
-					fs::error::ApiError::NullPtr(_) => Err(ApiError::NullPtr(sys::error::NullPtrError)),
-				}
-			}, // Err(err) => return Err(ApiError::from_err(err)),
+			Err(err) => return Err(ApiError::from_err(err)),
 		};
 
 		Self::new_with_size_with(api, size as _).map_err(Into::into)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,7 +2,7 @@

		High-level interface to file-system on-top of `playdate-sys` crate.

		⚠️ Until the version `0.3` API is unstable and can be changed partially.
		⚠️ Prior to the version `0.3` API is unstable and can be changed without deprecation period.



Expand Down