@@ -314,7 +314,7 @@ where
314
314
///
315
315
/// `[CHANNEL_MONITOR_PERSISTENCE_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1`
316
316
///
317
- /// Updates would be stored as follows (with `/` delimiting namespace/subnamespace /key):
317
+ /// Updates would be stored as follows (with `/` delimiting namespace/sub-namespace /key):
318
318
///
319
319
/// ```text
320
320
/// [CHANNEL_MONITOR_UPDATE_PERSISTENCE_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1/1
@@ -345,7 +345,7 @@ where
345
345
/// that succeeds, updates in the range between the old and new monitors are deleted. The `lazy`
346
346
/// flag is used on the [`KVStore::remove`] method, so there are no guarantees that the deletions
347
347
/// will complete. However, stale updates are not a problem for data integrity, since updates are
348
- /// only read that are higher than the stored [`ChannelMonitor`]'s update_id.
348
+ /// only read that are higher than the stored [`ChannelMonitor`]'s ` update_id` .
349
349
///
350
350
/// If you have many stale updates stored (such as after a crash with pending lazy deletes), and
351
351
/// would like to get rid of them, consider using the
@@ -373,7 +373,7 @@ where
373
373
ES :: Target : EntropySource + Sized ,
374
374
SP :: Target : SignerProvider + Sized ,
375
375
{
376
- /// Construct a new [`MonitorUpdatingPersister`].
376
+ /// Constructs a new [`MonitorUpdatingPersister`].
377
377
///
378
378
/// The `maximum_pending_updates` parameter controls how many updates may be stored before a
379
379
/// [`MonitorUpdatingPersister`] consolidates updates by writing a full monitor. Note that
@@ -548,7 +548,7 @@ where
548
548
/// Cleans up stale updates for all monitors.
549
549
///
550
550
/// This function works by first listing all monitors, and then for each of them, listing all
551
- /// updates. The updates that have an update_id less than or equal to than the stored monitor
551
+ /// updates. The updates that have an ` update_id` less than or equal to than the stored monitor
552
552
/// are deleted. The deletion can either be lazy or non-lazy based on the `lazy` flag; this will
553
553
/// be passed to [`KVStore::remove`].
554
554
pub fn cleanup_stale_updates ( & self , lazy : bool ) -> io:: Result < ( ) > {
@@ -703,7 +703,7 @@ where
703
703
/// In some cases, this will forward to [`MonitorUpdatingPersister::persist_new_channel`]:
704
704
///
705
705
/// - No full monitor is found in [`KVStore`]
706
- /// - The number of pending updates exceeds [`self. maximum_pending_updates`]
706
+ /// - The number of pending updates exceeds ` maximum_pending_updates` as given to [`Self::new `]
707
707
/// - LDK commands re-persisting the entire monitor through this function, specifically when
708
708
/// `update` is `None`.
709
709
/// - The update is at [`CLOSED_CHANNEL_UPDATE_ID`]
0 commit comments