add docstring

pinecone-io · Oct 29, 2023 · e83ca8d · e83ca8d
1 parent 3f26a52
commit e83ca8d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/canopy/knowledge_base/knowledge_base.py b/src/canopy/knowledge_base/knowledge_base.py
@@ -38,6 +38,17 @@
 
 
 def list_canopy_indexes() -> List[str]:
+    """
+    List all Canopy indexes in the current Pinecone account.
+
+    Example:
+        >>> from canopy.knowledge_base import list_canopy_indexes
+        >>> list_canopy_indexes()
+            ['canopy--my_index', 'canopy--my_index2']
+
+    Returns:
+        A list of Canopy index names.
+    """
 
     try:
         pinecone_init()