Skip to content

Commit 562ccf1

Browse files
domZippillitnull
andauthored
f docnits
Co-authored-by: Elias Rohrer <dev@tnull.de>
1 parent b0038a4 commit 562ccf1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lightning/src/util/persist.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ where
314314
///
315315
/// `[CHANNEL_MONITOR_PERSISTENCE_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1`
316316
///
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):
318318
///
319319
/// ```text
320320
/// [CHANNEL_MONITOR_UPDATE_PERSISTENCE_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1/1
@@ -345,7 +345,7 @@ where
345345
/// that succeeds, updates in the range between the old and new monitors are deleted. The `lazy`
346346
/// flag is used on the [`KVStore::remove`] method, so there are no guarantees that the deletions
347347
/// 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`.
349349
///
350350
/// If you have many stale updates stored (such as after a crash with pending lazy deletes), and
351351
/// would like to get rid of them, consider using the
@@ -373,7 +373,7 @@ where
373373
ES::Target: EntropySource + Sized,
374374
SP::Target: SignerProvider + Sized,
375375
{
376-
/// Construct a new [`MonitorUpdatingPersister`].
376+
/// Constructs a new [`MonitorUpdatingPersister`].
377377
///
378378
/// The `maximum_pending_updates` parameter controls how many updates may be stored before a
379379
/// [`MonitorUpdatingPersister`] consolidates updates by writing a full monitor. Note that
@@ -548,7 +548,7 @@ where
548548
/// Cleans up stale updates for all monitors.
549549
///
550550
/// 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
552552
/// are deleted. The deletion can either be lazy or non-lazy based on the `lazy` flag; this will
553553
/// be passed to [`KVStore::remove`].
554554
pub fn cleanup_stale_updates(&self, lazy: bool) -> io::Result<()> {
@@ -703,7 +703,7 @@ where
703703
/// In some cases, this will forward to [`MonitorUpdatingPersister::persist_new_channel`]:
704704
///
705705
/// - 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`]
707707
/// - LDK commands re-persisting the entire monitor through this function, specifically when
708708
/// `update` is `None`.
709709
/// - The update is at [`CLOSED_CHANNEL_UPDATE_ID`]

0 commit comments

Comments
 (0)