Skip to content

Commit

Permalink
fix bootstrap doc to omit private config
Browse files Browse the repository at this point in the history
  • Loading branch information
PanGan21 committed Mar 7, 2024
1 parent 5f8ef81 commit a58ed37
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions protocols/kad/src/behaviour.rs
Original file line number Diff line number Diff line change
Expand Up @@ -927,10 +927,10 @@ where
/// > See [`Behaviour::add_address`].
///
/// > **Note**: Bootstrap does not require to be called manually. It is periodically
/// invoked at regular intervals based on the configured `periodic_bootstrap_interval` and
/// `automatic_bootstrap_throttle` (see [`Config::set_periodic_bootstrap_interval`] for details)
/// and it is also automatically invoked when a new peer is inserted in the routing table.
/// These two config parameters are used to call [`Behaviour::bootstrap`] periodically and automatically
/// invoked at regular intervals based on the configured `periodic_bootstrap_interval` (see
/// [`Config::set_periodic_bootstrap_interval`] for details) and it is also automatically invoked
/// when a new peer is inserted in the routing table.
/// This parameter is used to call [`Behaviour::bootstrap`] periodically and automatically
/// to ensure a healthy routing table.
pub fn bootstrap(&mut self) -> Result<QueryId, NoKnownPeers> {
let local_key = self.kbuckets.local_key().clone();
Expand Down

0 comments on commit a58ed37

Please sign in to comment.