Last doc comment clean up #84
Merged
Conversation
This file contains 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
…ample of passing errorMode for import in integration test
austin-denoble
added a commit
that referenced
this pull request
Oct 23, 2024
## Problem We can actually hyperlink to all of the contents of the `Pinecone` package in our doc comments, which is nice. There's also a few final tweaks I want to get in before the release. ## Solution - Clean up doc comments and add links for various namespaces. - Add an example of passing errorMode for import in integration test. All of the changes here are to code comments, there aren't any actual changes to code included in this PR. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [X] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan `just docs` locally to serve the webpage including all of the client documentation
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
We can actually hyperlink to all of the contents of the
Pineconepackage in our doc comments, which is nice. There's also a few final tweaks I want to get in before the release.Solution
All of the changes here are to code comments, there aren't any actual changes to code included in this PR.
Type of Change
Test Plan
just docslocally to serve the webpage including all of the client documentation