Skip to content

docs: add 'Raises' sections to QdrantClient docstrings#1159

Open
toroleapinc wants to merge 1 commit intoqdrant:masterfrom
toroleapinc:docs/issue-348-raises-docstrings
Open

docs: add 'Raises' sections to QdrantClient docstrings#1159
toroleapinc wants to merge 1 commit intoqdrant:masterfrom
toroleapinc:docs/issue-348-raises-docstrings

Conversation

@toroleapinc
Copy link

Summary

Add Raises documentation sections to methods and properties in QdrantClient that explicitly raise exceptions.

Changes

Added Raises sections to the following:

  • QdrantClient class docstring (__init__): Documents ValueError raised when conflicting connection parameters are specified or when cloud_inference is used with local mode.
  • grpc_collections property: Documents NotImplementedError when used with local/in-memory mode.
  • grpc_points property: Documents NotImplementedError when used with local/in-memory mode.
  • http property: Documents NotImplementedError when used with local/in-memory mode.
  • update_collection method: Documents ValueError when both optimizer_config and optimizers_config are specified.

Notes

This is a first pass focusing on the main QdrantClient class 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

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>
@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for poetic-froyo-8baba7 failed.

Name Link
🔨 Latest commit b054449
🔍 Latest deploy log https://app.netlify.com/projects/poetic-froyo-8baba7/deploys/69a0fe8d4e234500082934a2

@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7101dc and b054449.

📒 Files selected for processing (1)
  • qdrant_client/qdrant_client.py

📝 Walkthrough

Walkthrough

This 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)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add 'Raises' sections to QdrantClient docstrings' clearly and concisely summarizes the main change: adding Raises documentation sections to QdrantClient docstrings.
Description check ✅ Passed The description is directly related to the changeset, providing details about which methods and properties received Raises sections and what exceptions they document.
Docstring Coverage ✅ Passed Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant