Document LiquidityManager persist result
What the developer wrote
Authored by Elias Rohrer
Document LiquidityManager persist result
Clarify the return value so callers know it reports whether the
forced peer-state write reached the store.
Co-Authored-By: HAL 9000
What changed, and why it matters
This commit only fixes two typos in documentation comments ('sevice' to 'service') and slightly rewords the description of what the return value means. No code behavior changes, no security relevance.
No action needed. This is a documentation-only typo fix with no security implications.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies two Rust doc comments in lightning-liquidity/src/manager.rs. It corrects a spelling error and clarifies that the boolean return value indicates whether the forced peer-state write reached the store. There are no functional code changes, no API changes, and no logic changes.
Changed components
lightning-liquidity/src/manager.rs documentation comments onlyInspect captured patch +2 / −2
diff --git a/lightning-liquidity/src/manager.rs b/lightning-liquidity/src/manager.rs
index f1b098d..64f5d97 100644
--- a/lightning-liquidity/src/manager.rs
+++ b/lightning-liquidity/src/manager.rs
@@ -618,7 +618,7 @@ where
/// Persists the state of the service handlers towards the given [`KVStore`] implementation if
/// needed.
///
- /// Returns `true` if it persisted sevice handler data.
+ /// Returns `true` if it persisted service handler data.
///
/// This will be regularly called by LDK's background processor if necessary and only needs to
/// be called manually if it's not utilized.
@@ -1111,7 +1111,7 @@ where
/// Persists the state of the service handlers towards the given [`KVStoreSync`] implementation.
///
- /// Returns `true` if it persisted sevice handler data.
+ /// Returns `true` if it persisted service handler data.
///
/// Wraps [`LiquidityManager::persist`].
pub fn persist(&self) -> Result<bool, lightning::io::Error> {
Why 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.