Address comments

pyth-network · Dec 18, 2024 · 4dc21b7 · 4dc21b7
1 parent f30d018
commit 4dc21b7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/sdk/rust/src/evm.rs b/sdk/rust/src/evm.rs
@@ -70,7 +70,7 @@ pub struct Config {
 ///
 /// # Errors
 ///
-/// Returns `ClientError::ChainNotSupported` if the chain ID is unrecognized.
+/// Returns `ClientError::ChainNotSupported` if the chain ID is unsupported.
 pub fn get_config(chain_id: &str) -> Result<Config, ClientError> {
     match chain_id {
         "mode" => Ok(Config {
@@ -168,11 +168,11 @@ pub fn make_permitted_tokens(
 ///
 /// # Returns
 ///
-/// * `Result<ExecutionParams, ClientError>` - Execution parameters including permits and witness details.
+/// * `Result<ExecutionParams, ClientError>` - Execution parameters including permit and witness details.
 ///
 /// # Errors
 ///
-/// Returns an error if permit2 compatible permitted tokens cannot be constructed.
+/// Returns an error if Permit2 compatible permitted tokens cannot be constructed.
 pub fn make_opportunity_execution_params(
     opportunity: OpportunityEvm,
     bid_params: BidParamsEvm,

diff --git a/sdk/rust/src/lib.rs b/sdk/rust/src/lib.rs
@@ -349,7 +349,7 @@ impl WsClient {
         }
     }
 
-    /// Subscribes to updates for specific blockchain chains.
+    /// Subscribes to updates for specific blockchains.
     ///
     /// # Arguments
     ///
@@ -376,7 +376,7 @@ impl WsClient {
         }
     }
 
-    /// Unsubscribes from updates for specific blockchain chains.
+    /// Unsubscribes from updates for specific blockchains.
     ///
     /// # Arguments
     ///
@@ -462,7 +462,7 @@ impl Client {
     ///
     /// # Implementation Details
     ///
-    /// - If the HTTP response is valid but contains an error body, the function returns a
+    /// - If the HTTP response is valid but contains an error body that can be decoded to `ErrorBodyResponse`, the function returns a
     ///   `ClientError::RequestError` with the server's error message.
     /// - If the HTTP response fails to decode, it returns `ClientError::DecodeResponseFailed`.
     /// - Errors due to request failure (e.g., network issues) are returned as `ClientError::RequestFailed`.
@@ -494,7 +494,7 @@ impl Client {
     ///
     /// # Arguments
     ///
-    /// * `config` - The client configuration containing HTTP URL and optional API key.
+    /// * `config` - The client configuration containing an HTTP URL and an optional API key.
     ///
     /// # Returns
     ///
@@ -537,7 +537,7 @@ impl Client {
     ///
     /// # Errors
     ///
-    /// Returns an error if the connection or WebSocket handshake fails.
+    /// Returns an error if the connection or the WebSocket handshake fails.
     ///
     /// # Thread Safety
     ///