Edit docstrings

Author: jhamon

docs/_static/custom.css

@@ -12,3 +12,22 @@ div.admonition p.admonition-title {
 .blurb {
     font-size: 16px;
 }
+
+p.admonition-title:after {
+    content: "";
+}
+
+div.code-block-caption {
+    background-color: #EEE;
+    border-bottom: 1px solid #CCC;
+    font-size: 17px;
+    padding: 10px;
+}
+
+dt:target {
+    background-color: #E8E8E8;
+}
+
+.highlight {
+    background-color: #F8F8F8;
+}

pinecone/config/pinecone_config.py

@@ -5,7 +5,7 @@
 from .config import ConfigBuilder, Config
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 DEFAULT_CONTROLLER_HOST = "https://api.pinecone.io"
 

pinecone/db_control/db_control.py

@@ -9,7 +9,7 @@
 
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 if TYPE_CHECKING:
     from .resources.sync.index import IndexResource
@@ -24,13 +24,13 @@ def __init__(
         self, config: "Config", openapi_config: "OpenApiConfiguration", pool_threads: int
     ) -> None:
         self.config = config
-        """ @private """
+        """ :meta private: """
 
         self._openapi_config = openapi_config
-        """ @private """
+        """ :meta private: """
 
         self._pool_threads = pool_threads
-        """ @private """
+        """ :meta private: """
 
         self._index_api = setup_openapi_client(
             api_client_klass=ApiClient,
@@ -40,19 +40,19 @@ def __init__(
             pool_threads=self._pool_threads,
             api_version=API_VERSION,
         )
-        """ @private """
+        """ :meta private: """
 
         self._index_resource: Optional["IndexResource"] = None
-        """ @private """
+        """ :meta private: """
 
         self._collection_resource: Optional["CollectionResource"] = None
-        """ @private """
+        """ :meta private: """
 
         self._restore_job_resource: Optional["RestoreJobResource"] = None
-        """ @private """
+        """ :meta private: """
 
         self._backup_resource: Optional["BackupResource"] = None
-        """ @private """
+        """ :meta private: """
 
         super().__init__()  # Initialize PluginAware
 

pinecone/db_control/db_control_asyncio.py

@@ -8,7 +8,7 @@
 from pinecone.core.openapi.db_control import API_VERSION
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 
 if TYPE_CHECKING:
@@ -22,10 +22,10 @@
 class DBControlAsyncio:
     def __init__(self, config: "Config", openapi_config: "OpenApiConfiguration") -> None:
         self._config = config
-        """ @private """
+        """ :meta private: """
 
         self._openapi_config = openapi_config
-        """ @private """
+        """ :meta private: """
 
         self._index_api = setup_async_openapi_client(
             api_client_klass=AsyncioApiClient,
@@ -34,19 +34,19 @@ def __init__(self, config: "Config", openapi_config: "OpenApiConfiguration") ->
             openapi_config=self._openapi_config,
             api_version=API_VERSION,
         )
-        """ @private """
+        """ :meta private: """
 
         self._index_resource: Optional["IndexResourceAsyncio"] = None
-        """ @private """
+        """ :meta private: """
 
         self._collection_resource: Optional["CollectionResourceAsyncio"] = None
-        """ @private """
+        """ :meta private: """
 
         self._restore_job_resource: Optional["RestoreJobResourceAsyncio"] = None
-        """ @private """
+        """ :meta private: """
 
         self._backup_resource: Optional["BackupResourceAsyncio"] = None
-        """ @private """
+        """ :meta private: """
 
     @property
     def index(self) -> "IndexResourceAsyncio":

pinecone/db_control/request_factory.py

@@ -49,12 +49,12 @@
 
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 
 class PineconeDBControlRequestFactory:
     """
-    @private
+    :meta private:
 
     This class facilitates translating user inputs into request objects.
     """

pinecone/db_control/resources/asyncio/backup.py

@@ -9,7 +9,7 @@
 class BackupResourceAsyncio:
     def __init__(self, index_api: AsyncioManageIndexesApi):
         self._index_api = index_api
-        """ @private """
+        """ :meta private: """
 
     @require_kwargs
     async def list(

pinecone/db_control/resources/asyncio/collection.py

@@ -6,7 +6,7 @@
 from pinecone.utils import require_kwargs
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 
 class CollectionResourceAsyncio:

pinecone/db_control/resources/asyncio/index.py

@@ -29,7 +29,7 @@
 from pinecone.utils import require_kwargs
 
 logger = logging.getLogger(__name__)
-""" @private """
+""" :meta private: """
 
 
 class IndexResourceAsyncio:

pinecone/db_control/resources/asyncio/restore_job.py

@@ -8,7 +8,7 @@
 class RestoreJobResourceAsyncio:
     def __init__(self, index_api: AsyncioManageIndexesApi):
         self._index_api = index_api
-        """ @private """
+        """ :meta private: """
 
     @require_kwargs
     async def get(self, *, job_id: str) -> RestoreJobModel:

pinecone/db_control/resources/sync/backup.py

@@ -18,16 +18,16 @@ def __init__(
         pool_threads: int,
     ):
         self._index_api = index_api
-        """ @private """
+        """ :meta private: """
 
         self.config = config
-        """ @private """
+        """ :meta private: """
 
         self._openapi_config = openapi_config
-        """ @private """
+        """ :meta private: """
 
         self._pool_threads = pool_threads
-        """ @private """
+        """ :meta private: """
 
         super().__init__()  # Initialize PluginAware