Skip to content

docs: clarify PointStruct usage for IDs in README example#1147

Open
uahroberto wants to merge 1 commit intoqdrant:masterfrom
uahroberto:docs/improve-readme-pointstruct
Open

docs: clarify PointStruct usage for IDs in README example#1147
uahroberto wants to merge 1 commit intoqdrant:masterfrom
uahroberto:docs/improve-readme-pointstruct

Conversation

@uahroberto
Copy link
Copy Markdown

Description

This PR updates the "Insert vectors into a collection" example in the README to explicitly clarify the usage of PointStruct.

Motivation:
Users (as seen in issue #1141) are encountering ImportError when trying to import internal classes like PointId to handle custom IDs (UUIDs). This update adds a comment to the code snippet clarifying that PointStruct handles ID types automatically, promoting best practices and preventing confusion.

Changes:

  • Added explanatory comment in the client.upsert example in README.md.

Closes #1141

All Submissions:

  • Contributions should target the dev branch. Did you create your branch from dev?
  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

@netlify
Copy link
Copy Markdown

netlify bot commented Jan 28, 2026

Deploy Preview for poetic-froyo-8baba7 ready!

Name Link
🔨 Latest commit 92dcd15
🔍 Latest deploy log https://app.netlify.com/projects/poetic-froyo-8baba7/deploys/697a4607e5882900070e6d5c
😎 Deploy Preview https://deploy-preview-1147--poetic-froyo-8baba7.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

The README.md file was updated with a single-line inline comment added to the upsert points code example. The comment clarifies the use of PointStruct for strict typing and notes that point IDs can be integers or strings (UUIDs). This is a purely documentation-focused change with no behavioral or logic modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive While the PR adds a clarifying comment about PointStruct ID handling, issue #1141 requests comprehensive documentation covering multiple import sources and HTTP vs gRPC usage patterns. The PR appears to partially address the issue but may not fully satisfy all stated requirements. Verify whether the single comment addition adequately addresses the broader documentation gaps identified in issue #1141, or consider expanding the README updates to cover recommended imports and gRPC/HTTP mode guidance.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly describes the main change: documenting PointStruct usage for IDs in the README example. It is concise, specific, and directly related to the changeset.
Description check ✅ Passed The PR description is relevant to the changeset, clearly explaining the motivation (issue #1141), the change made (adding a comment in the README), and what it addresses.
Out of Scope Changes check ✅ Passed All changes are within scope—adding a clarifying comment to the README example aligns with the PR's stated objective to address issue #1141 regarding PointStruct usage documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

Request clarification for qdrant imports and update for README page

2 participants