Skip to content

Block Handler Doc Update#732

Merged
keenbeen32 merged 1 commit intomainfrom
nb/block-handler-update
Nov 10, 2025
Merged

Block Handler Doc Update#732
keenbeen32 merged 1 commit intomainfrom
nb/block-handler-update

Conversation

@nikbhintade
Copy link
Member

@nikbhintade nikbhintade commented Nov 10, 2025

Block handler doesn't provide bulk sql updates so removed it from docs.

Summary by CodeRabbit

  • Documentation
    • Updated onBlock API documentation to clarify supported use cases.

@vercel
Copy link

vercel bot commented Nov 10, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
envio-docs Ready Ready Preview Comment Nov 10, 2025 8:25am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025

Walkthrough

Documentation update to the onBlock API description in the block-handlers guide. Removed reference to "bulk updates using raw SQL" and narrowed the use cases to "aggregations and time-series logic."

Changes

Cohort / File(s) Summary
Documentation Update
docs/HyperIndex/Guides/block-handlers.md
Updated onBlock API descriptive paragraph: removed "bulk updates using raw SQL" reference and refined use cases to focus on "aggregations and time-series logic"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • v2.29 #703: Modifies the same block-handlers.md documentation file with related changes to the onBlock API description

Suggested reviewers

  • DenhamPreen

Poem

🐰 A tweak to the docs, so clear and bright,
The onBlock API shines just right,
No SQL bulk, just time-series flow,
Aggregations dance in Envio's glow!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Block Handler Doc Update' directly summarizes the main change: updating documentation for the block handler API to remove inaccurate information about bulk SQL updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch nb/block-handler-update

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef001df and 8251c8d.

📒 Files selected for processing (1)
  • docs/HyperIndex/Guides/block-handlers.md (1 hunks)
🔇 Additional comments (1)
docs/HyperIndex/Guides/block-handlers.md (1)

15-15: Documentation accuracy improvement.

The narrowed scope to "aggregations and time-series logic" accurately reflects the feature's capabilities and is well-supported by the examples throughout the guide (hourly price calculations, interval-based logic, historical/realtime handlers). Removing the misleading reference to bulk SQL updates clarifies the intended use cases.


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.

@keenbeen32 keenbeen32 merged commit 231b587 into main Nov 10, 2025
3 checks passed
@keenbeen32 keenbeen32 deleted the nb/block-handler-update branch November 10, 2025 09:23
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.

2 participants