miscellaneous documentation improvements

Author: Ekleog

src/factory.rs

@@ -13,7 +13,7 @@ use web_sys::{
 
 /// Wrapper for [`IDBFactory`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory)
 ///
-/// Note that it's quite likely that type inference will fail on the `Err` generic argument here.
+/// Note that it is quite likely that type inference will fail on the `Err` generic argument here.
 /// This argument is the type of user-defined errors that will be passed through transactions and
 /// callbacks.
 /// You should set it to whatever error type your program uses around the `indexed-db`-using code.
@@ -85,8 +85,8 @@ impl<Err: 'static> Factory<Err> {
     /// Returns an error if something failed while opening or upgrading the database.
     /// Blocks until it can actually open the database.
     ///
-    /// Note that `version` must be at least `1`. `upgrader` will be called when `version` is higher than the previous
-    /// database version, or upon database creation.
+    /// Note that `version` must be at least `1`. `on_upgrade_needed` will be called when `version` is higher
+    /// than the previous database version, or upon database creation.
     ///
     /// This internally uses [`IDBFactory::open`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory/open)
     /// as well as the methods from [`IDBOpenDBRequest`](https://developer.mozilla.org/en-US/docs/Web/API/IDBOpenDBRequest)
@@ -183,14 +183,14 @@ impl<Err> VersionChangeEvent<Err> {
 
     /// The version before the database upgrade, clamped to `u32::MAX`
     ///
-    /// Internally, this uses [`IDBVersionChangeEvent::old_version`](https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent/oldVersion)
+    /// Internally, this uses [`IDBVersionChangeEvent::oldVersion`](https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent/oldVersion)
     pub fn old_version(&self) -> u32 {
         self.sys.old_version() as u32
     }
 
     /// The version after the database upgrade, clamped to `u32::MAX`
     ///
-    /// Internally, this uses [`IDBVersionChangeEvent::new_version`](https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent/newVersion)
+    /// Internally, this uses [`IDBVersionChangeEvent::newVersion`](https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent/newVersion)
     pub fn new_version(&self) -> u32 {
         self.sys
             .new_version()

src/index.rs

@@ -156,7 +156,7 @@ impl<Err> Index<Err> {
         }
     }
 
-    /// List all the keys in the object store, with a maximum number of results of `limit`, ordered by this index
+    /// List all the keys (for this index) in the object store, with a maximum number of results of `limit`, ordered by this index
     ///
     /// Internally, this uses [`IDBIndex::getAllKeys`](https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAllKeys).
     pub fn get_all_keys(

src/object_store.rs

@@ -52,8 +52,7 @@ impl<Err> ObjectStore<Err> {
 
     /// Delete an index from this object store
     ///
-    /// Note that this method can only be called from within an `on_upgrade_needed` callback. It returns
-    /// a builder, and calling the `create` method on this builder will perform the actual creation.
+    /// Note that this method can only be called from within an `on_upgrade_needed` callback.
     ///
     /// Internally, this uses [`IDBObjectStore::deleteIndex`](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/deleteIndex).
     pub fn delete_index(&self, name: &str) -> crate::Result<(), Err> {
@@ -66,7 +65,7 @@ impl<Err> ObjectStore<Err> {
             })
     }
 
-    /// Add the value `val` to this object store, and return its auto-computed key
+    /// Add the value `value` to this object store, and return its auto-computed key
     ///
     /// This will error if the key already existed.
     ///
@@ -78,7 +77,7 @@ impl<Err> ObjectStore<Err> {
         }
     }
 
-    /// Add the value `val` to this object store, with key `key`
+    /// Add the value `value` to this object store, with key `key`
     ///
     /// This will error if the key already existed.
     ///
@@ -96,7 +95,7 @@ impl<Err> ObjectStore<Err> {
         }
     }
 
-    /// Sets the value `val` to this object store, and return its auto-computed key
+    /// Add the value `value` to this object store, and return its auto-computed key
     ///
     /// This will overwrite the previous value if the key already existed.
     ///
@@ -108,7 +107,7 @@ impl<Err> ObjectStore<Err> {
         }
     }
 
-    /// Add the value `val` to this object store, with key `key`
+    /// Add the value `value` to this object store, with key `key`
     ///
     /// This will overwrite the previous value if the key already existed.
     ///
@@ -126,7 +125,7 @@ impl<Err> ObjectStore<Err> {
         }
     }
 
-    /// Clears this object store
+    /// Clear this object store
     ///
     /// Internally, this uses [`IDBObjectStore::clear`](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/clear).
     pub fn clear(&self) -> impl Future<Output = crate::Result<(), Err>> {
@@ -144,7 +143,7 @@ impl<Err> ObjectStore<Err> {
         }
     }
 
-    /// Counts the number of objects in this store
+    /// Count the number of objects in this store
     ///
     /// Internally, this uses [`IDBObjectStore::count`](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/count).
     pub fn count(&self) -> impl Future<Output = crate::Result<usize, Err>> {

src/transaction.rs

@@ -146,7 +146,7 @@ impl<Err> Transaction<Err> {
 
     /// Returns an [`ObjectStore`] that can be used to operate on data in this transaction
     ///
-    /// Internally, this uses [`IDBTransaction::object_store`](https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction/objectStore).
+    /// Internally, this uses [`IDBTransaction::objectStore`](https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction/objectStore).
     pub fn object_store(&self, name: &str) -> crate::Result<ObjectStore<Err>, Err> {
         Ok(ObjectStore::from_sys(self.sys.object_store(name).map_err(
             |err| match error_name!(&err) {