Skip to content

Commit 45656ae

Browse files
committed
docs(sphinx): add _AssistantNamespaceProxy to nitpick_ignore
## Purpose Sphinx autodoc renders return types as cross-references in HTML. `Pinecone.assistant` returns `_AssistantNamespaceProxy`, a private class, which would produce a broken reference link or build warning in nitpicky mode without a `nitpick_ignore` entry. ## Solution Added `pinecone.client._assistant_namespace_proxy._AssistantNamespaceProxy` to the `nitpick_ignore` list in `docs/conf.py`, following the same pattern already used for `PineconeConfig`, `RetryConfig`, `HTTPClient`, and `AsyncHTTPClient`.
1 parent 07c87b2 commit 45656ae

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

‎docs/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
("py:class", "pinecone._internal.config.RetryConfig"),
7373
("py:class", "pinecone._internal.http_client.HTTPClient"),
7474
("py:class", "pinecone._internal.http_client.AsyncHTTPClient"),
75+
("py:class", "pinecone.client._assistant_namespace_proxy._AssistantNamespaceProxy"),
7576
]
7677

7778
myst_enable_extensions = ["colon_fence", "deflist"]

0 commit comments

Comments
 (0)