Skip to content

Commit 06a2b81

Browse files
committed
Update BackgroundProcessor persist API doc
1 parent 5feb2c2 commit 06a2b81

File tree

1 file changed

+5
-6
lines changed
  • lightning-background-processor/src

1 file changed

+5
-6
lines changed

lightning-background-processor/src/lib.rs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,20 +131,19 @@ impl BackgroundProcessor {
131131
/// documentation].
132132
///
133133
/// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
134-
/// `persist_manager` returns an error. In case of an error, the error is retrieved by calling
134+
/// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
135135
/// either [`join`] or [`stop`].
136136
///
137137
/// # Data Persistence
138138
///
139-
/// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
139+
/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
140140
/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
141141
/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
142142
/// provided implementation.
143143
///
144-
/// `persist_graph` is responsible for writing out the [`NetworkGraph`] to disk. See
145-
/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See
146-
/// [`FilesystemPersister::persist_network_graph`] for Rust-Lightning's
147-
/// provided implementation.
144+
/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
145+
/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
146+
/// for Rust-Lightning's provided implementation.
148147
///
149148
/// Typically, users should either implement [`Persister::persist_manager`] to never return an
150149
/// error or call [`join`] and handle any error that may arise. For the latter case,

0 commit comments

Comments
 (0)