Skip to content

Commit 1e71d32

Browse files
committed
Clean up some doc links in lightning_block_sync.
Relative HTML doc paths in doc links works locally, but breaks on crates.io. Luckily, we can now use explicit full paths and rustdoc will resolve them for us.
1 parent ccdbac4 commit 1e71d32

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

lightning-block-sync/src/init.rs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use lightning::chain;
99

1010
/// Returns a validated block header of the source's best chain tip.
1111
///
12-
/// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh
12+
/// Upon success, the returned header can be used to initialize [`crate::SpvClient`]. Useful during a fresh
1313
/// start when there are no chain listeners to sync yet.
1414
pub async fn validate_best_block_header<B: BlockSource>(block_source: &mut B) ->
1515
BlockSourceResult<ValidatedBlockHeader> {
@@ -22,12 +22,12 @@ BlockSourceResult<ValidatedBlockHeader> {
2222
/// Performs a one-time sync of chain listeners using a single *trusted* block source, bringing each
2323
/// listener's view of the chain from its paired block hash to `block_source`'s best chain tip.
2424
///
25-
/// Upon success, the returned header can be used to initialize [`SpvClient`]. In the case of
25+
/// Upon success, the returned header can be used to initialize [`crate::SpvClient`]. In the case of
2626
/// failure, each listener may be left at a different block hash than the one it was originally
2727
/// paired with.
2828
///
2929
/// Useful during startup to bring the [`ChannelManager`] and each [`ChannelMonitor`] in sync before
30-
/// switching to [`SpvClient`]. For example:
30+
/// switching to [`crate::SpvClient`]. For example:
3131
///
3232
/// ```
3333
/// use bitcoin::hash_types::BlockHash;
@@ -113,9 +113,8 @@ BlockSourceResult<ValidatedBlockHeader> {
113113
/// }
114114
/// ```
115115
///
116-
/// [`SpvClient`]: ../struct.SpvClient.html
117-
/// [`ChannelManager`]: ../../lightning/ln/channelmanager/struct.ChannelManager.html
118-
/// [`ChannelMonitor`]: ../../lightning/chain/channelmonitor/struct.ChannelMonitor.html
116+
/// [`ChannelManager`]: `lightning::ln::channelmanager::ChannelManager`
117+
/// [`ChannelMonitor`]: `lightning::chain::channelmonitor::ChannelMonitor`
119118
pub async fn synchronize_listeners<B: BlockSource, C: Cache>(
120119
block_source: &mut B,
121120
network: Network,

0 commit comments

Comments
 (0)