Fix outdated PersistenceNotifierGuard comment
What the developer wrote
Authored by elnosh
Fix outdated PersistenceNotifierGuard comment
What changed, and why it matters
This commit only updates an internal code comment to match the current API names. No code behavior changes, no security relevance.
No action needed; this is a non-functional documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies a doc comment for PersistenceNotifierGuard in lightning/src/ln/channelmanager.rs, replacing references to the old await_persistable_update_timeout/await_persistable_update methods with the current ChannelManager::get_event_or_persistence_needed_future. There are no functional code changes.
Changed components
lightning/src/ln/channelmanager.rsInspect captured patch +6 / −5
### lightning/src/ln/channelmanager.rs
@@ -3181,11 +3181,12 @@ enum NotifyOption {
}
/// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
-/// desirable to notify any listeners on `await_persistable_update_timeout`/
-/// `await_persistable_update` when new updates are available for persistence. Therefore, this
-/// struct is responsible for locking the total consistency lock and, upon going out of scope,
-/// sending the aforementioned notification (since the lock being released indicates that the
-/// updates are ready for persistence).
+/// desirable to notify any listeners on the `Future` returned by
+/// `ChannelManager::get_event_or_persistence_needed_future` when new updates are available for
+/// persistence or new events are available for handling. Therefore, this struct is responsible for
+/// locking the total consistency lock and, upon going out of scope, sending the aforementioned
+/// notification (since the lock being released indicates that the updates are ready for
+/// persistence).
///
/// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
/// notify or not based on whether relevant changes have been made, providing a closure toWhy this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.