Skip to content

Commit 497051a

Browse files
committed
docs(config): add Returns section to Pinecone.config and AsyncPinecone.config
## Purpose The `config` property docstrings were missing a `Returns:` section, violating the documentation convention that requires it for all non-None-returning methods. ## Solution Added `Returns: :class:`~pinecone._internal.config.PineconeConfig`` section to both `Pinecone.config` and `AsyncPinecone.config`, consistent with sibling namespace properties. Preserved the existing `Examples:` section in `_client.py`.
1 parent 5d3f88e commit 497051a

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

‎pinecone/_client.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,10 @@ def create_index_from_backup(
531531
def config(self) -> PineconeConfig:
532532
"""The resolved configuration for this client.
533533
534+
Returns:
535+
:class:`~pinecone._internal.config.PineconeConfig` containing the
536+
resolved API key, host, timeout, and connection settings.
537+
534538
Examples:
535539
536540
>>> cfg = pc.config

‎pinecone/async_client/pinecone.py‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,12 @@ async def create_index_from_backup(
432432

433433
@property
434434
def config(self) -> PineconeConfig:
435-
"""The resolved configuration for this client."""
435+
"""The resolved configuration for this client.
436+
437+
Returns:
438+
:class:`~pinecone._internal.config.PineconeConfig` containing the
439+
resolved API key, host, timeout, and connection settings.
440+
"""
436441
return self._config
437442

438443
# ---- Backcompat flat-method delegates (:meta private:) ----

0 commit comments

Comments
 (0)