docs: add 'Raises' sections to QdrantClient docstrings#1159
docs: add 'Raises' sections to QdrantClient docstrings#1159toroleapinc wants to merge 1 commit intoqdrant:masterfrom
Conversation
Add 'Raises' documentation to methods and properties in QdrantClient that explicitly raise exceptions: - QdrantClient.__init__: ValueError for conflicting parameters - grpc_collections, grpc_points, http properties: NotImplementedError when used with local/in-memory mode - update_collection: ValueError for conflicting optimizer configs This is a first pass addressing qdrant#348, focusing on the main QdrantClient class. Additional methods can be documented in follow-up PRs. Relates to qdrant#348 Signed-off-by: edvatar <88481784+toroleapinc@users.noreply.github.com>
❌ Deploy Preview for poetic-froyo-8baba7 failed.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis pull request adds "Raises" sections to existing docstrings in qdrant_client.py to document error conditions. The changes document ValueError exceptions in QdrantClient.init for conflicting initialization parameters and in update_collection for conflicting configuration options. Additionally, NotImplementedError exceptions are documented for grpc_collections, grpc_points, and http properties when accessed on non-remote Qdrant instances. No functional code or method signatures are modified. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Add
Raisesdocumentation sections to methods and properties inQdrantClientthat explicitly raise exceptions.Changes
Added
Raisessections to the following:QdrantClientclass docstring (__init__): DocumentsValueErrorraised when conflicting connection parameters are specified or whencloud_inferenceis used with local mode.grpc_collectionsproperty: DocumentsNotImplementedErrorwhen used with local/in-memory mode.grpc_pointsproperty: DocumentsNotImplementedErrorwhen used with local/in-memory mode.httpproperty: DocumentsNotImplementedErrorwhen used with local/in-memory mode.update_collectionmethod: DocumentsValueErrorwhen bothoptimizer_configandoptimizers_configare specified.Notes
This is a first pass focusing on the main
QdrantClientclass methods that directly raise exceptions. Additional methods in the remote/local backends and the async client can be documented in follow-up PRs.Relates to #348