Skip to content

Commit

Permalink
docs: clarify client documentation
Browse files Browse the repository at this point in the history
Again, these changes are just to effect a release.

A change to the release workflow also removes testing the environment variable and re-exporting it.
On the last build I ran, it appears to have worked as expected, where previously it didn't. Doesn't
really make any sense.
  • Loading branch information
jacderida authored and RolandSherwin committed Apr 8, 2024
1 parent cb76aa2 commit 54223b4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions sn_client/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,15 @@ const CONNECTION_TIMEOUT: Duration = Duration::from_secs(30);
const INACTIVITY_TIMEOUT: Duration = Duration::from_secs(30);

impl Client {
/// A quick client that only takes some peers to connect to
/// A quick client with a random secret key and some peers.
pub async fn quick_start(peers: Option<Vec<Multiaddr>>) -> Result<Self> {
Self::new(SecretKey::random(), peers, None, None).await
}

/// Instantiate a new client.
///
/// Optionally specify the maximum time the client will wait for a connection before timing out.
/// Optionally specify the duration for the connection timeout.
///
/// Defaults to 180 seconds.
///
/// # Arguments
Expand Down

0 comments on commit 54223b4

Please sign in to comment.