From 98c6566b01e3a05b6db7c9ff79f57efec7429b8b Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Wed, 17 Mar 2021 14:04:02 -0400 Subject: [PATCH] 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. --- lightning-block-sync/src/init.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs index 83e356919..e9ff09894 100644 --- a/lightning-block-sync/src/init.rs +++ b/lightning-block-sync/src/init.rs @@ -11,6 +11,8 @@ use lightning::chain; /// /// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh /// start when there are no chain listeners to sync yet. +/// +/// [`SpvClient`]: crate::SpvClient pub async fn validate_best_block_header(block_source: &mut B) -> BlockSourceResult { let (best_block_hash, best_block_height) = block_source.get_best_block().await?; @@ -113,9 +115,9 @@ BlockSourceResult { /// } /// ``` /// -/// [`SpvClient`]: ../struct.SpvClient.html -/// [`ChannelManager`]: ../../lightning/ln/channelmanager/struct.ChannelManager.html -/// [`ChannelMonitor`]: ../../lightning/chain/channelmonitor/struct.ChannelMonitor.html +/// [`SpvClient`]: crate::SpvClient +/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager +/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor pub async fn synchronize_listeners( block_source: &mut B, network: Network, -- 2.39.5