f docnits

Co-authored-by: Elias Rohrer <[email protected]>

Author: domZippilli

lightning/src/util/persist.rs

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