Skip to content

docs(readme): remove em dashes and drop project status table - #2

Merged
joalves merged 1 commit into
mainfrom
docs/readme-cleanup
Aug 14, 2026
Merged

docs(readme): remove em dashes and drop project status table#2
joalves merged 1 commit into
mainfrom
docs/readme-cleanup

Conversation

@joalves

@joalves joalves commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replace every em dash in README.md with punctuation that fits the sentence (comma, colon, or period)
  • Remove the "Project status" heading, blockquote, and Area/Status table
  • The install snippet that sat under that heading now has its own ## Install heading so the document still flows

Docs only; no code or behavior changes.

🤖 Generated with Claude Code (via agent-run, /start-feature)

Summary by CodeRabbit

  • Documentation
    • Improved punctuation and readability throughout the README.
    • Standardised formatting across installation, command usage, analysis, filtering, templates, API conventions, and testing guidance.
    • No documented functionality or public interfaces were changed.

Replace every em dash in README.md with punctuation that fits the
sentence (comma, colon, or period) and remove the "Project status"
heading, blockquote, and Area/Status table. The install snippet that
sat under that heading now has its own "## Install" heading so the
document still flows.

Docs only; no code or behavior changes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ffc404a8-b7fc-4933-8796-4ac6ab1c9d8e

📥 Commits

Reviewing files that changed from the base of the PR and between 7fd3d03 and 7a3340d.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The pull request updates README headings and punctuation across installation, command, analysis, piping, filtering, templates, core API, and testing sections. It replaces em dashes with full stops, colons, commas, or parentheses. Documented fields, examples, semantics, and API declarations remain unchanged.

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

Merge Risk: ⚪ Minimal · up to 7a334

This change only updates README.md formatting and structure, with no code or behavior changes; no actionable merge-blocking risk remains.

Poem

A rabbit reads the README bright,
Where commas hop in neat delight.
The dashes rest, the words stay clear,
No changed commands or APIs here.
“Thump, thump!” says Bun, “the docs are right!”

🚥 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 accurately describes the README punctuation changes and the removal of the project status table.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-cleanup

Comment @coderabbitai help to get the list of available commands.

@joalves
joalves merged commit b15b791 into main Aug 14, 2026
5 checks passed
@joalves
joalves deleted the docs/readme-cleanup branch August 14, 2026 20:07
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