-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[DOC] Add Python SDK client parameter reference (#5407) #5734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
|
Add Python SDK parameter reference docs and link from index Documentation-only PR that introduces a new Markdown page ( Key Changes• Added new reference file Affected Areas• Documentation site: Python reference section This summary was automatically generated by @propel-code-bot |
docs/docs.trychroma.com/markdoc/content/reference/python/client-params.md
Outdated
Show resolved
Hide resolved
…ned in the table above. Either document `images` in the parameter table or remove it from this bullet to avoid confusion.
Himanshu7921
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applied all Suggestions
|
Hi maintainers 👋 Could you please approve the workflow runs for this pull request? Once the workflows are approved, all required checks should run and report their results, allowing the PR to move forward in the review and merge process. If you have any feedback or requested changes after the checks complete, please let me know—I’m happy to address them promptly. Thank you very much for your time and for helping with the approval and review! |
Description
This PR adds a focused, practical Python SDK reference page that documents the most commonly used client and API parameter objects in the Chroma Python client. The new page provides concise tables describing parameter keys, example values, and usage notes for:
ChromaClientParams)Each section includes short, copy-paste Python examples to support quick onboarding and diagnostics. An example end-to-end workflow is also included. This reference directly addresses the request in issue #5407 by making parameter keys and usage patterns discoverable and easy to validate.
In addition, the main Python reference index (
chroma-reference.md) now links to the new page for improved discoverability.No changes were made to runtime code or API behavior—this is a documentation-only update.
What changed
docs/docs.trychroma.com/markdoc/content/reference/python/client-params.mddocs/docs.trychroma.com/markdoc/content/reference/chroma-reference.mdMotivation
Existing documentation does not clearly list the accepted keys and example values for client and API parameter objects. This PR provides a concise and approachable reference so contributors and integrators can quickly see:
This resource is designed to reduce onboarding friction for new contributors and prevent repetitive review questions about parameter usage.
How to review
docs/docs.trychroma.com/markdoc/content/reference/python/client-params.mddocs/docs.trychroma.com/markdoc/content/reference/chroma-reference.mdAddresses: #5407