From 54223b414d6334ff99ca635fede0b948cba9ae69 Mon Sep 17 00:00:00 2001 From: Chris O'Neil Date: Wed, 3 Apr 2024 23:22:06 +0100 Subject: [PATCH] docs: clarify client documentation 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. --- sn_client/src/api.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/sn_client/src/api.rs b/sn_client/src/api.rs index 9fb21d5f63..7fad35d576 100644 --- a/sn_client/src/api.rs +++ b/sn_client/src/api.rs @@ -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>) -> Result { 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