Skip to content

Commit b52f1ab

Browse files
committed
docs(client): add Examples section to Pinecone.config docstring
## Purpose The `config` property docstring lacked an `Examples:` section, violating the documentation convention that requires at least one concrete usage example for public properties. ## Solution Added a doctest block showing how to access `pc.config` and read the `timeout` field. The example is runnable under the global doctest setup (which already provides `pc = Pinecone(api_key="test-key")`).
1 parent 004783d commit b52f1ab

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

‎pinecone/_client.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,14 @@ def create_index_from_backup(
529529

530530
@property
531531
def config(self) -> PineconeConfig:
532-
"""The resolved configuration for this client."""
532+
"""The resolved configuration for this client.
533+
534+
Examples:
535+
536+
>>> cfg = pc.config
537+
>>> cfg.timeout
538+
30.0
539+
"""
533540
return self._config
534541

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

0 commit comments

Comments
 (0)