Skip to content

doc: fix better the python api example#2080

Open
yihong0618 wants to merge 1 commit into
rapidsai:mainfrom
yihong0618:hy/better_readme
Open

doc: fix better the python api example#2080
yihong0618 wants to merge 1 commit into
rapidsai:mainfrom
yihong0618:hy/better_readme

Conversation

@yihong0618
Copy link
Copy Markdown

This is a small change for python example that as other language examples
the cagra.build first arg is index_params is better here for users can easily
understand as build_params is not init here

Signed-off-by: yihong0618 <zouzou0208@gmail.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 14, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@yihong0618 yihong0618 changed the title docs: fix better the python api example doc: fix better the python api example May 14, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2f134578-ce47-4905-830c-baad77021b25

📥 Commits

Reviewing files that changed from the base of the PR and between 86b9038 and ddfe1a9.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Fixed the Python getting started guide example to ensure sample code runs correctly.

Walkthrough

This PR corrects the Python API example in README.md by updating the cagra.build invocation to use the correct parameter name index_params instead of build_params. No other documentation sections or code examples are affected.

Changes

Documentation Example Correction

Layer / File(s) Summary
Python CAGRA API example parameter name fix
README.md
The cagra.build invocation in the Python "Getting Started" snippet now uses the correct parameter name index_params instead of the previously undefined build_params.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is partially related to the changeset. It mentions 'fix better the python api example,' which accurately describes the change (fixing/updating a Python example), but the phrasing is awkward and could be more concise.
Description check ✅ Passed The description is clearly related to the changeset. It explicitly explains the change: updating the Python example to use 'index_params' instead of 'build_params' as the first argument to cagra.build for better clarity and consistency with other language examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

@cjnolet cjnolet added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels May 14, 2026
@cjnolet cjnolet moved this to In Progress in Unstructured Data Processing May 14, 2026
@cjnolet
Copy link
Copy Markdown
Member

cjnolet commented May 14, 2026

/ok to test ddfe1a9

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

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants