Skip to content

Commit

Permalink
Update docstring language
Browse files Browse the repository at this point in the history
  • Loading branch information
emily-emily committed Jun 11, 2024
1 parent b441ec8 commit b417681
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions pinecone_sdk/src/config.rs
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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<String>) -> Self {
Config {
api_key,
Expand All @@ -26,4 +26,4 @@ impl Config {
source_tag,
}
}
}
}
8 changes: 4 additions & 4 deletions pinecone_sdk/src/pinecone.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ 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,

Check warning on line 13 in pinecone_sdk/src/pinecone.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `config` is never read

Check warning on line 13 in pinecone_sdk/src/pinecone.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `config` is never read

Check warning on line 13 in pinecone_sdk/src/pinecone.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `config` is never read

Check warning on line 13 in pinecone_sdk/src/pinecone.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `config` is never read

/// OpenAPI configuration object.
openapi_config: Configuration,
}

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
Expand Down Expand Up @@ -360,4 +360,4 @@ mod tests {
mock_arg_headers.clone()
);
}
}
}

0 comments on commit b417681

Please sign in to comment.