Skip to content

Commit

Permalink
Clarify stale remove_stale.. docs and logs
Browse files Browse the repository at this point in the history
.. we were already doing the right thing, but our docs were stale.
  • Loading branch information
tnull committed Feb 5, 2025
1 parent fb45e18 commit 30e5fab
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions lightning-background-processor/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,9 @@ macro_rules! define_run_body {
log_trace!($logger, "Pruning and persisting network graph.");
network_graph.remove_stale_channels_and_tracking_with_time(duration_since_epoch.as_secs());
} else {
log_warn!($logger, "Not pruning network graph, consider enabling `std` or doing so manually with remove_stale_channels_and_tracking_with_time.");
log_warn!($logger,
"Not pruning network graph, consider implementing the fetch_time argument or calling remove_stale_channels_and_tracking_with_time manually."
);
log_trace!($logger, "Persisting network graph.");
}

Expand Down Expand Up @@ -612,11 +614,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
/// Requires the `futures` feature. Note that while this method is available without the `std`
/// feature, doing so will skip calling [`NetworkGraph::remove_stale_channels_and_tracking`],
/// you should call [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] regularly
/// manually instead.
///
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand Down

0 comments on commit 30e5fab

Please sign in to comment.