Skip to content

Benchmark prominence#78

Merged
d33bs merged 2 commits into
WayScience:mainfrom
d33bs:benchmarks-mention
Jun 8, 2026
Merged

Benchmark prominence#78
d33bs merged 2 commits into
WayScience:mainfrom
d33bs:benchmarks-mention

Conversation

@d33bs

@d33bs d33bs commented Jun 8, 2026

Copy link
Copy Markdown
Member

Description

This PR helps to document benchmarks for the audience reading these materials.

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added references to the ome-arrow-benchmarks repository for detailed benchmark results throughout documentation
    • Clarified that benchmark results are preliminary and workload/layout dependent
    • Enhanced related projects section with benchmark repository reference

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@d33bs, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 26 minutes and 11 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ccf6b8a1-12c4-4ef3-ae6e-e2d1d775a797

📥 Commits

Reviewing files that changed from the base of the PR and between a05285e and dfeccde.

📒 Files selected for processing (2)
  • README.md
  • docs/src/why-ome-arrow.md
📝 Walkthrough

Walkthrough

Documentation updates across README.md, docs/src/presentations.md, and docs/src/why-ome-arrow.md add or refine references pointing readers to the ome-arrow-benchmarks repository for detailed benchmark results, design decision rationale, and performance analysis.

Changes

Documentation references to ome-arrow-benchmarks

Layer / File(s) Summary
References to ome-arrow-benchmarks repository across documentation
README.md, docs/src/presentations.md, docs/src/why-ome-arrow.md
README intro, benchmarking section, and related projects link add or update references to ome-arrow-benchmarks. Presentations.md and why-ome-arrow.md each introduce a reference to the repository for design context and preliminary results caveats, respectively.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A well-placed link, a helpful sight,
Points curious minds to benchmarks bright.
Across the docs, a path we trace,
To ome-arrow's benchmark space.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Benchmark prominence' directly relates to the main objective of the PR, which is to make benchmarks more prominent and understandable throughout the documentation.
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

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.

@d33bs d33bs changed the title benchmark prominence Benchmark prominence Jun 8, 2026
@d33bs d33bs marked this pull request as ready for review June 8, 2026 20:54
@d33bs d33bs requested a review from gwaybio June 8, 2026 21:09
Comment thread docs/src/why-ome-arrow.md Outdated
Comment thread README.md Outdated
Co-authored-by: Gregory Way <gregory.way@gmail.com>
@d33bs

d33bs commented Jun 8, 2026

Copy link
Copy Markdown
Member Author

Thanks @gwaybio !

@d33bs d33bs merged commit 0327832 into WayScience:main Jun 8, 2026
13 checks passed
@d33bs d33bs deleted the benchmarks-mention branch June 8, 2026 21:32
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