Skip to content

Commit 6137f08

Browse files
authored
Clarify and expand docstrings. (#187)
## Problem Current plans to automate Python client documentation generation consume client docstrings. Some of these strings are currently incomplete or unclear. ## Solution This PR expands and clarifies the docstrings in the Python client. ## 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)
1 parent 734fb56 commit 6137f08

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

pinecone/core/client/api/index_operations_api.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
#
44

55
"""
6-
Pinecone API
6+
Pinecone index operations API
77
8-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
8+
# noqa: E501
99
10-
The version of the OpenAPI document: version not set
1110
12-
Generated by: https://openapi-generator.tech
1311
"""
1412

1513

@@ -188,7 +186,7 @@ def __create_collection(
188186
):
189187
"""create_collection # noqa: E501
190188
191-
This operation creates a Pinecone collection. # noqa: E501
189+
This operation creates a Pinecone collection from an existing index. # noqa: E501
192190
This method makes a synchronous HTTP request by default. To make an
193191
asynchronous HTTP request, please pass async_req=True
194192
@@ -313,7 +311,7 @@ def __create_index(
313311
):
314312
"""create_index # noqa: E501
315313
316-
This operation creates a Pinecone index. You can use it to specify the measure of similarity, the dimension of vectors to be stored in the index, the numbers of shards and replicas to use, and more. # noqa: E501
314+
This operation creates a Pinecone index. Specify the distance metric, the dimension of vectors to be stored in the index, the numbers replicas to use, and the collection from which to create the index, if applicable. # noqa: E501
317315
This method makes a synchronous HTTP request by default. To make an
318316
asynchronous HTTP request, please pass async_req=True
319317
@@ -699,7 +697,7 @@ def __describe_collection(
699697
):
700698
"""describe_collection # noqa: E501
701699
702-
Get a description of a collection. # noqa: E501
700+
Get a description of a collection, including the name, size, and status. # noqa: E501
703701
This method makes a synchronous HTTP request by default. To make an
704702
asynchronous HTTP request, please pass async_req=True
705703
@@ -829,7 +827,7 @@ def __describe_index(
829827
):
830828
"""describe_index # noqa: E501
831829
832-
Get a description of an index. # noqa: E501
830+
Get a description of an index, including dimension, distance metric, number of replicas, and more. # noqa: E501
833831
This method makes a synchronous HTTP request by default. To make an
834832
asynchronous HTTP request, please pass async_req=True
835833
@@ -1076,7 +1074,7 @@ def __list_indexes(
10761074
):
10771075
"""list_indexes # noqa: E501
10781076
1079-
This operation returns a list of your Pinecone indexes. # noqa: E501
1077+
This operation returns a list of the indexes in the current project. # noqa: E501
10801078
This method makes a synchronous HTTP request by default. To make an
10811079
asynchronous HTTP request, please pass async_req=True
10821080

0 commit comments

Comments
 (0)