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.
This commit is contained in:
Henry de Valence 2020-10-21 19:33:56 -07:00
parent 1d7309afe2
commit b5a43f4516
1 changed files with 0 additions and 4 deletions

View File

@ -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