Skip to content

docs: fix benchmark table separator column count mismatch#163

Closed
membphis wants to merge 1 commit into
mainfrom
feature-issue-162
Closed

docs: fix benchmark table separator column count mismatch#163
membphis wants to merge 1 commit into
mainfrom
feature-issue-162

Conversation

@membphis

@membphis membphis commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Fix malformed markdown table separators. Three tables had extra separator cells. Fixes issue 162.

Summary by CodeRabbit

  • Documentation
    • Fixed table formatting in benchmark documentation for improved readability.

@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown

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: Pro

Run ID: af2df606-98fc-4d15-942d-62d36a14614c

📥 Commits

Reviewing files that changed from the base of the PR and between 8e1b394 and 5b4ac37.

📒 Files selected for processing (1)
  • docs/benchmarks.md

📝 Walkthrough

Walkthrough

This PR corrects Markdown table separator row formatting in three benchmark result tables within docs/benchmarks.md. Column alignment markers are adjusted across the x86_64 throughput, modify+encode throughput, and memory delta tables to ensure proper table rendering.

Changes

Benchmark table formatting

Layer / File(s) Summary
Benchmark table separator alignment
docs/benchmarks.md
Markdown table header separator rows (|--- ... |) are adjusted for three benchmark result tables (lines 111, 154, 192) to correct column-alignment formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • #162: Both changes modify the Markdown table separator rows in docs/benchmarks.md to fix column-count/alignment mismatches in the benchmark tables.

Poem

🐰 Three tables stand in Markdown row,
With separators now aligned just so.
Column counts dance in perfect beat,
Benchmark docs are now complete!
Hop, hop, hooray for formatting neat! 🎉

🚥 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 'docs: fix benchmark table separator column count mismatch' directly and clearly describes the main change: fixing benchmark table separators in documentation by correcting column count issues.
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
  • Commit unit tests in branch feature-issue-162

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.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.05.

Benchmark suite Current: 5b4ac37 Previous: 8e1b394 Ratio
parse_lazy/parse/deep_nesting 2872 ns/iter (± 37) 2623 ns/iter (± 75) 1.09

This comment was automatically generated by workflow using github-action-benchmark.

@membphis membphis closed this Jun 7, 2026
@membphis membphis deleted the feature-issue-162 branch June 7, 2026 17:40
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.

1 participant