Skip to content

Commit 98c6566

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 c88e3eb commit 98c6566

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning-block-sync/src/init.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ use lightning::chain;
1111
///
1212
/// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh
1313
/// start when there are no chain listeners to sync yet.
14+
///
15+
/// [`SpvClient`]: crate::SpvClient
1416
pub async fn validate_best_block_header<B: BlockSource>(block_source: &mut B) ->
1517
BlockSourceResult<ValidatedBlockHeader> {
1618
let (best_block_hash, best_block_height) = block_source.get_best_block().await?;
@@ -113,9 +115,9 @@ BlockSourceResult<ValidatedBlockHeader> {
113115
/// }
114116
/// ```
115117
///
116-
/// [`SpvClient`]: ../struct.SpvClient.html
117-
/// [`ChannelManager`]: ../../lightning/ln/channelmanager/struct.ChannelManager.html
118-
/// [`ChannelMonitor`]: ../../lightning/chain/channelmonitor/struct.ChannelMonitor.html
118+
/// [`SpvClient`]: crate::SpvClient
119+
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
120+
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
119121
pub async fn synchronize_listeners<B: BlockSource, C: Cache>(
120122
block_source: &mut B,
121123
network: Network,

0 commit comments

Comments
 (0)