Update documentation (#115)

Author: Spxg

README.md

@@ -1,5 +1,3 @@
-# SQLite Wasm Rust
-
 [![Crates.io](https://img.shields.io/crates/v/sqlite-wasm-rs.svg)](https://crates.io/crates/sqlite-wasm-rs)
 
 Provide sqlite solution for `wasm32-unknown-unknown` target.
@@ -93,11 +91,11 @@ Here is an example showing how to use `sqlite-wasm-rs` to implement a simple in-
 This library is not thread-safe:
 
 * `JsValue` is not cross-threaded, see <https://github.com/rustwasm/wasm-bindgen/pull/955> for details.
-* sqlite is compiled with `-DSQLITE_THREADSAFE=0`
+* sqlite is compiled with `-DSQLITE_THREADSAFE=0`.
 
 ## Precompiled libsqlite3.a
 
-Since `wasm32-unknown-unknown` does not have sysroot, emscripten is used here for compilation, otherwise we need to copy a bunch of c headers required for sqlite3 compilation. If sqlite3 is compiled at compile time, the emscripten toolchain is required, and we cannot assume that all users have it installed. (Believe me, because rust mainly supports the `wasm32-unknown-unknown` target, most people do not have the emscripten toolchain). Considering that wasm is cross-platform, vendor compilation products are acceptable.
+Since `wasm32-unknown-unknown` does not have sysroot, emscripten is used here for compilation, otherwise we need to copy a bunch of c headers required for sqlite3 compilation. If bundled feature is enabled, the emscripten toolchain is required, and we cannot assume that all users have it installed. (Believe me, because rust mainly supports the `wasm32-unknown-unknown` target, most people do not have the emscripten toolchain). Considering that wasm is cross-platform, vendor compilation products are acceptable.
 
 About security:
 
@@ -127,11 +125,6 @@ export CFLAGS_wasm32_unknown_emscripten="-mno-reference-types"
 
 used to disable `reference-types` of the C library.
 
-## Nice Try
-
-* [`diesel`](https://github.com/diesel-rs/diesel): A safe, extensible ORM and Query Builder for Rust.
-* [`sqlight`](https://github.com/Spxg/sqlight): A SQLite Playground that runs completely locally.
-
 ## Related Project
 
 * [`diesel`](https://github.com/diesel-rs/diesel): A safe, extensible ORM and Query Builder for Rust.

src/vfs/memory.rs

@@ -160,7 +160,7 @@ pub enum MemVfsError {
     Generic(String),
 }
 
-/// MemVfs management tools exposed to clients.
+/// MemVfs management tool.
 pub struct MemVfsUtil(&'static VfsAppData<MemAppData>);
 
 unsafe impl Send for MemVfsUtil {}
@@ -244,12 +244,12 @@ impl MemVfsUtil {
         }
     }
 
-    /// Delete the specified database, please make sure that the database is closed.
+    /// Delete the specified database, make sure that the database is closed.
     pub fn delete_db(&self, filename: &str) {
         self.0.borrow_mut().remove(filename);
     }
 
-    /// Delete all database, please make sure that all database is closed.
+    /// Delete all database, make sure that all database is closed.
     pub fn clear_all(&self) {
         std::mem::take(&mut *self.0.borrow_mut());
     }

src/vfs/relaxed_idb.rs

@@ -796,7 +796,7 @@ impl RelaxedIdbCfgBuilder {
         self
     }
 
-    /// Build `RelaxedIdbCfg`
+    /// Build `RelaxedIdbCfg`.
     pub fn build(self) -> RelaxedIdbCfg {
         self.0
     }
@@ -828,7 +828,7 @@ impl Default for RelaxedIdbCfg {
     }
 }
 
-/// RelaxedIdb management tools exposed to clients.
+/// RelaxedIdbVfs management tool.
 pub struct RelaxedIdbUtil {
     pool: &'static VfsAppData<RelaxedIdb>,
 }
@@ -873,12 +873,12 @@ impl RelaxedIdbUtil {
         self.pool.export_db(filename)
     }
 
-    /// Delete the specified database, please make sure that the database is closed.
+    /// Delete the specified database, make sure that the database is closed.
     pub fn delete_db(&self, filename: &str) -> Result<WaitCommit> {
         self.pool.delete_db(filename)
     }
 
-    /// Delete all database, please make sure that all database is closed.
+    /// Delete all database, make sure that all database is closed.
     pub fn clear_all(&self) -> Result<WaitCommit> {
         self.pool.clear_all()
     }
@@ -899,11 +899,11 @@ impl RelaxedIdbUtil {
     }
 }
 
-/// Register `relaxed-idb` vfs and return a utility object which can be used
-/// to perform basic administration of the file pool
+/// Register `relaxed-idb` vfs and return a management tool which can be used
+/// to perform basic administration of the file pool.
 ///
 /// If the vfs corresponding to `options.vfs_name` has been registered,
-/// only return a utility object.
+/// only return a management tool without register.
 pub async fn install(options: &RelaxedIdbCfg, default_vfs: bool) -> Result<RelaxedIdbUtil> {
     static REGISTER_GUARD: tokio::sync::Mutex<()> = tokio::sync::Mutex::const_new(());
     let _guard = REGISTER_GUARD.lock().await;

src/vfs/sahpool.rs

@@ -620,7 +620,7 @@ impl OpfsSAHPoolCfgBuilder {
         self
     }
 
-    /// Build OpfsSAHPoolCfg
+    /// Build `OpfsSAHPoolCfg`.
     pub fn build(self) -> OpfsSAHPoolCfg {
         self.0
     }
@@ -636,7 +636,7 @@ impl Default for OpfsSAHPoolCfgBuilder {
 pub struct OpfsSAHPoolCfg {
     /// The SQLite VFS name under which this pool's VFS is registered.
     pub vfs_name: String,
-    /// Specifies the OPFS directory name in which to store metadata for the `vfs_name`
+    /// Specifies the OPFS directory name in which to store metadata for the `vfs_name`.
     pub directory: String,
     /// If truthy, contents and filename mapping are removed from each SAH
     /// as it is acquired during initalization of the VFS, leaving the VFS's
@@ -701,10 +701,7 @@ impl OpfsSAHError {
     }
 }
 
-/// A OpfsSAHPoolUtil instance is exposed to clients in order to
-/// manipulate an OpfsSAHPool object without directly exposing that
-/// object and allowing for some semantic changes compared to that
-/// class.
+/// SAHPoolVfs management tool.
 pub struct OpfsSAHPoolUtil {
     pool: &'static VfsAppData<SyncAccessHandleAppData>,
 }
@@ -760,12 +757,12 @@ impl OpfsSAHPoolUtil {
         self.pool.export_db(filename)
     }
 
-    /// Delete the specified database, please make sure that the database is closed.
+    /// Delete the specified database, make sure that the database is closed.
     pub fn delete_db(&self, filename: &str) -> Result<bool> {
         self.pool.delete_file(filename)
     }
 
-    /// Delete all database, please make sure that all database is closed.
+    /// Delete all database, make sure that all database is closed.
     pub async fn clear_all(&self) -> Result<()> {
         self.pool.release_access_handles();
         self.pool.acquire_access_handles(true).await?;
@@ -788,11 +785,11 @@ impl OpfsSAHPoolUtil {
     }
 }
 
-/// Register `opfs-sahpool` vfs and return a utility object which can be used
-/// to perform basic administration of the file pool
+/// Register `opfs-sahpool` vfs and return a management tool which can be used
+/// to perform basic administration of the file pool.
 ///
 /// If the vfs corresponding to `options.vfs_name` has been registered,
-/// only return a utility object.
+/// only return a management tool without register.
 pub async fn install(options: &OpfsSAHPoolCfg, default_vfs: bool) -> Result<OpfsSAHPoolUtil> {
     static REGISTER_GUARD: tokio::sync::Mutex<()> = tokio::sync::Mutex::const_new(());
     let _guard = REGISTER_GUARD.lock().await;