docs: fix malformed benchmark throughput table

Open Beginner friendly
#162 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
markdown
Domain
documentation

Research direction

Open docs/benchmarks.md and inspect the x86_64 throughput table around line 110. Compare its header with the separator row, then check nearby benchmark tables for the same column-count issue. Done means the affected separator rows match their headers and the Markdown tables render without an extra column.

Written by the indexing model from the issue text.

Description

Problem

In docs/benchmarks.md, the x86_64 throughput table has a column-count mismatch.

At the table starting around line 110, the header defines 7 columns:

| Scenario | Size | cjson | simdjson | `qjson.parse` | `qjson.decode + access content` | `qjson.decode + qjson.encode` |

But the separator row defines 8 columns:

|---|---|---:|---:|---:|---:|---:|---:|

This can render the Markdown table with an extra empty column or otherwise malformed alignment.

Expected fix

Remove the extra trailing separator cell so the separator row has 7 columns, matching the header.

It is also worth checking nearby benchmark tables for the same issue.

Dominant language
Rust
Stars
2
Forks
0
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from api7/lua-qjson

All issues in api7/lua-qjson

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.