Update documentation #36
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emily-emily
reviewed
Jul 22, 2024
pinecone_sdk/src/pinecone/mod.rs
Outdated
| /// ``` | ||
| pub fn new( | ||
| api_key: Option<String>, | ||
| control_plane_host: Option<String>, | ||
| additional_headers: Option<HashMap<String, String>>, | ||
| source_tag: Option<String>, | ||
| ) -> Result<Self, PineconeError> { | ||
| // get api key | ||
| // clean api key |
pinecone_sdk/src/pinecone/mod.rs
Outdated
| /// | ||
| /// // Create a Pinecone client with the API key and controller host. | ||
| /// let pinecone = PineconeClient::new(Some("INSERT_API_KEY".to_string()), Some("INSERT_CONTROLLER_HOST".to_string()), None, None); | ||
| /// # Ok(()) | ||
| /// # } |
There was a problem hiding this comment.
I don't think we need this hidden code for this section since there's no async
pinecone_sdk/src/pinecone/data.rs
Outdated
| @@ -138,8 +142,10 @@ impl Index { | |||
| /// # async fn main() -> Result<(), PineconeError>{ | |||
| /// let pinecone = PineconeClient::new(None, None, None, None).unwrap(); | |||
| /// | |||
| /// // Connect to the index "index-host" | |||
There was a problem hiding this comment.
Could we word this better? "index-host" is the host url of the index rather than the name
emily-emily
approved these changes
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Parts of the docstrings are either outdated or not consistent.
Solution
I updated documentation in parts where it was either outdated or inconsistent. I also added comments to code snippets.
Type of Change
Test Plan
Test cases should pass since no code was changed. Code snippets in docstrings should still compile.