Skip to content

Commit 07c87b2

Browse files
committed
docs(client): add Args section to configure_index docstring
## Purpose `configure_index` has 8 parameters but no Args section in its docstring, violating the convention that Args is required for all public methods with parameters. Missing docs affect IDE hover tooltips and help() in the REPL. ## Solution Added a complete Args section to the `configure_index` docstring covering all 8 parameters (name, replicas, pod_type, deletion_protection, tags, embed, read_capacity, serverless_read_capacity) with types and descriptions that parallel those of the canonical `Indexes.configure` delegate.
1 parent 5e955c8 commit 07c87b2

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

‎pinecone/_client.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,23 @@ def configure_index(
675675
Preserved to ease migration from the legacy Pinecone Python SDK. New code
676676
should use ``pc.indexes.configure()`` instead of ``pc.configure_index()``.
677677
678+
Args:
679+
name (str): Name of the index to configure.
680+
replicas (int | None): Number of replicas. Only applies to pod-based indexes.
681+
Defaults to ``None`` (no change).
682+
pod_type (str | None): Pod type (e.g. ``"p1.x1"``). Only applies to pod-based
683+
indexes. Defaults to ``None`` (no change).
684+
deletion_protection (DeletionProtection | str | None): Whether to enable deletion
685+
protection (``"enabled"`` or ``"disabled"``). Defaults to ``None`` (no change).
686+
tags (Mapping[str, str] | None): Key-value tags to apply to the index. Defaults to
687+
``None`` (no change).
688+
embed (dict[str, Any] | None): Integrated inference embedding configuration.
689+
Defaults to ``None`` (no change).
690+
read_capacity (dict[str, Any] | None): Read capacity settings for the index.
691+
Defaults to ``None`` (no change).
692+
serverless_read_capacity (dict[str, Any] | None): Serverless read capacity settings.
693+
Defaults to ``None`` (no change).
694+
678695
:meta private:
679696
"""
680697
self.indexes.configure(

0 commit comments

Comments
 (0)