From: vmammal Date: Wed, 17 Jan 2024 18:41:23 +0000 (-0500) Subject: doc(store): update doc for `Store::aggregate_changesets` X-Git-Tag: v1.0.0-alpha.5~4^2 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/address/enum.NetworkChecked.html?a=commitdiff_plain;h=3829fc18c7f2d16d2c72852bde4b4b70bff8e370;p=bdk doc(store): update doc for `Store::aggregate_changesets` --- diff --git a/crates/file_store/src/store.rs b/crates/file_store/src/store.rs index ebab2fd0..2cc0f8c8 100644 --- a/crates/file_store/src/store.rs +++ b/crates/file_store/src/store.rs @@ -137,9 +137,9 @@ where /// Loads all the changesets that have been stored as one giant changeset. /// - /// This function returns a tuple of the aggregate changeset and a result that indicates - /// whether an error occurred while reading or deserializing one of the entries. If so the - /// changeset will consist of all of those it was able to read. + /// This function returns the aggregate changeset, or `None` if nothing was persisted. + /// If reading or deserializing any of the entries fails, an error is returned that + /// consists of all those it was able to read. /// /// You should usually check the error. In many applications, it may make sense to do a full /// wallet scan with a stop-gap after getting an error, since it is likely that one of the