Updated javadoc for Pinecone class - Githubissues

pinecone-io / pinecone-java-client

The official Java client for the Pinecone vector database

https://www.pinecone.io

Apache License 2.0

36 stars 13 forks source link

Updated javadoc for Pinecone class #111

Closed ssmith-pc closed 6 months ago

ssmith-pc commented 6 months ago

Problem

Updates Javadocs for all methods on the Pinecone class to make consistent use of {@code ...} blocks, simplify/format code samples.

Solution

Describe the approach you took. Link to any relevant bugs, issues, docs, or other resources.

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

Describe specific steps for validating this change.