From b41768149355552821c0100a43534b8b882fe811 Mon Sep 17 00:00:00 2001 From: Emily Yu Date: Tue, 11 Jun 2024 13:22:19 -0400 Subject: [PATCH] Update docstring language --- pinecone_sdk/src/config.rs | 8 ++++---- pinecone_sdk/src/pinecone.rs | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pinecone_sdk/src/config.rs b/pinecone_sdk/src/config.rs index a44cc8d..27cfe31 100644 --- a/pinecone_sdk/src/config.rs +++ b/pinecone_sdk/src/config.rs @@ -1,12 +1,12 @@ use std::collections::HashMap; -/// Configuration for the Pinecone SDK object. +/// Configuration for the Pinecone SDK struct. #[derive(Debug, Clone)] pub struct Config { /// The API key for your Pinecone project. You can find this in the [Pinecone console](https://app.pinecone.io). pub api_key: String, - /// Configuration field for specifying the controller host. + /// Optional configuration field for specifying the controller host. pub controller_url: String, /// Optional headers to be included in all requests. @@ -17,7 +17,7 @@ pub struct Config { } impl Config { - /// Builds a new Config object. + /// Builds a new Config struct. pub fn new(api_key: String, source_tag: Option) -> Self { Config { api_key, @@ -26,4 +26,4 @@ impl Config { source_tag, } } -} \ No newline at end of file +} diff --git a/pinecone_sdk/src/pinecone.rs b/pinecone_sdk/src/pinecone.rs index 0caff06..af90d5e 100644 --- a/pinecone_sdk/src/pinecone.rs +++ b/pinecone_sdk/src/pinecone.rs @@ -6,10 +6,10 @@ use openapi::apis::configuration::Configuration; use serde_json; use std::collections::HashMap; -/// The `Pinecone` class is the main entry point for interacting with Pinecone via this Rust SDK. +/// The `Pinecone` struct is the main entry point for interacting with Pinecone via this Rust SDK. #[derive(Debug, Clone)] pub struct Pinecone { - /// Configuration for the Pinecone SDK object. + /// Configuration for the Pinecone SDK struct. config: Config, /// OpenAPI configuration object. @@ -17,7 +17,7 @@ pub struct Pinecone { } impl Pinecone { - /// The `Pinecone` class is the main entry point for interacting with Pinecone via this Rust SDK. + /// The `Pinecone` struct is the main entry point for interacting with Pinecone via this Rust SDK. /// It is used to create, delete, and manage your indexes and collections. /// /// ### Configuration with environment variables @@ -360,4 +360,4 @@ mod tests { mock_arg_headers.clone() ); } -} \ No newline at end of file +}