From b5a43f45160118795c0aac539d3ef37b53f2525e Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Wed, 21 Oct 2020 19:33:56 -0700 Subject: [PATCH] zebrad: remove implementation details from docs The timeout behavior in zebra-network is an implementation detail, not a feature of the public API. So it shouldn't be mentioned in the doc comments -- if we want timeout behavior, we have to layer it ourselves. --- zebrad/src/components/sync.rs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/zebrad/src/components/sync.rs b/zebrad/src/components/sync.rs index b40bd9e6..43b8f521 100644 --- a/zebrad/src/components/sync.rs +++ b/zebrad/src/components/sync.rs @@ -45,13 +45,9 @@ const BLOCK_DOWNLOAD_RETRY_LIMIT: usize = 2; const LOOKAHEAD_LIMIT: usize = zebra_consensus::MAX_CHECKPOINT_HEIGHT_GAP * 2; /// Controls how long we wait for a tips response to return. -/// -/// The network layer also imposes a timeout on requests. const TIPS_RESPONSE_TIMEOUT: Duration = Duration::from_secs(6); /// Controls how long we wait for a block download request to complete. -/// -/// The network layer also imposes a timeout on requests. const BLOCK_DOWNLOAD_TIMEOUT: Duration = Duration::from_secs(20); /// The maximum amount of time that Zebra should take to download a checkpoint