Skip to content

docs: fix consistency of byte units (kb to kB)#77

Open
KoHaRxnP wants to merge 1 commit into
dashersw:mainfrom
KoHaRxnP:main
Open

docs: fix consistency of byte units (kb to kB)#77
KoHaRxnP wants to merge 1 commit into
dashersw:mainfrom
KoHaRxnP:main

Conversation

@KoHaRxnP

@KoHaRxnP KoHaRxnP commented Jul 2, 2026

Copy link
Copy Markdown

I noticed that while the tables use uppercase B for bytes (e.g., 214 B), the text sections and the comparison table use lowercase kb.

I've updated the lowercase kb instances to kB to keep the unit notation accurate and consistent throughout the README.


P.S. I love Gea's philosophy so much that I've just built a data-fetching library for it called gea-query! I also opened an issue (#76 ) to propose adding it to the ecosystem docs. If you have some time, I'd be honored if you could check it out as well!

Summary by CodeRabbit

  • Documentation
    • Clarified size-unit labels in benchmark and comparison text, changing “kb” to “kB” for brotli JavaScript figures.
    • Updated example and bundle-size comparison wording for consistency across the README.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR corrects unit formatting in README.md, changing "kb" to "kB" for brotli JavaScript size figures across four sections: hello-world comparison, interactive todo example, near-zero baseline bullets, and the bundle-size comparison table.

Changes

README size-unit corrections

Layer / File(s) Summary
Unit label corrections
README.md
Corrects brotli JavaScript size unit text from "kb" to "kB" in the hello-world sentence, interactive todo sentence, near-zero baseline bullets, and comparison table.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Related Issues: None mentioned in the provided context.

Related PRs: None mentioned in the provided context.

Suggested labels: documentation

Suggested reviewers: dashersw

Poem

A tiny hop, a letter's case,
"kb" now stands with proper grace.
Kilobytes get their due respect,
"kB" shines bright, precise, correct.
— a rabbit's nod to README's face 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README change to standardize byte units from kb to kB.
✨ 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.

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