Clean up some doc links in lightning_block_sync.
authorMatt Corallo <git@bluematt.me>
Wed, 17 Mar 2021 18:04:02 +0000 (14:04 -0400)
committerMatt Corallo <git@bluematt.me>
Thu, 18 Mar 2021 15:28:23 +0000 (11:28 -0400)
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

index 83e356919b8e231a8d4a3bda41b0d65645e146fc..e9ff098940c67de501634781dc4cdc7a86c3484c 100644 (file)
@@ -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<B: BlockSource>(block_source: &mut B) ->
 BlockSourceResult<ValidatedBlockHeader> {
        let (best_block_hash, best_block_height) = block_source.get_best_block().await?;
@@ -113,9 +115,9 @@ BlockSourceResult<ValidatedBlockHeader> {
 /// }
 /// ```
 ///
-/// [`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<B: BlockSource, C: Cache>(
        block_source: &mut B,
        network: Network,