Skip to content

Fix em-dash prose punctuation across messages and docs - #13

Merged
alperien merged 1 commit into
mainfrom
humanizer-pass
Jul 30, 2026
Merged

Fix em-dash prose punctuation across messages and docs#13
alperien merged 1 commit into
mainfrom
humanizer-pass

Conversation

@alperien

@alperien alperien commented Jul 29, 2026

Copy link
Copy Markdown
Owner

The same pass that went over agent-swarm and guavabread, guided by blader/humanizer. chartarr's docs and interaction text were already plain and specific, so this pass is almost entirely punctuation: the em dash used as prose punctuation, which is the most reliable AI tell and the one thing the earlier README rewrites did not sweep.

What changed, 13 files:

  • Error messages and status lines in cli.py, lidarr.py, review.py, and demo.py now join their clauses with semicolons, colons, or parentheses instead of em dashes. Wording is otherwise byte-identical, so every substring the tests pin still matches.
  • Docstrings and comments in the package and the tests get the same treatment, including the paired-dash asides in lidarr.py and test_lidarr.py.
  • CHANGELOG.md loses its eight em dashes. The bold entry headlines stay; each one is the summary of a fix, not scaffolding.
  • init.py's module docstring now matches cli.py's hyphen style.

What deliberately keeps its em dashes:

  • The artist and title separator the TUI prints ("Fleetwood Mac — Rumours"), the review screen header, and the year-range display. That is output formatting, not prose, and test_review pins it.
  • Comments and tests that quote those strings as data.

No LLM prompts exist in this repo. The interaction surface (help text, error messages, the setup wizard) already does what a good prompt does: it names the cause and the fix in one line. Nothing there needed more than punctuation.

Verification: pytest 142/142, ruff clean. The scanner reports zero hard hits outside the kept separators.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Refined punctuation, wording, and line wrapping across the changelog and inline documentation.
  • User Experience

    • Improved consistency and readability of terminal status, setup, import, matching, connection, and error messages.
  • Tests

    • Updated test comments and assertion messages for consistent punctuation without changing test behavior.

…gelog

Replace prose em dashes with semicolons, colons, commas, or parentheses
in error messages, docstrings, code comments, test comments, and
CHANGELOG entries. The em dash stays where it is data or chrome: the
artist-title separator the TUI prints, the review screen header, the
year-range display, and quoted examples of those strings. 142 tests
pass and ruff is clean.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The pull request standardizes punctuation and wording across changelog entries, runtime messages, docstrings, comments, and test descriptions. No executable logic, public declarations, assertions, or control flow changed.

Changes

Text formatting updates

Layer / File(s) Summary
Source messages and supporting text
CHANGELOG.md, chartarr/*, tests/*
Punctuation, wording, line wrapping, comments, docstrings, and user-facing messages are reformatted while runtime behavior and test logic remain unchanged.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 53.33% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: replacing em-dash prose punctuation across messages and documentation.
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 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch humanizer-pass

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.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 20: Update the changelog wording from “afterwards” to “afterward” in the
affected sentence, preserving the rest of the text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 82ffb0d9-caaf-458d-8218-04244b163d87

📥 Commits

Reviewing files that changed from the base of the PR and between d623872 and 8597e4a.

📒 Files selected for processing (13)
  • CHANGELOG.md
  • chartarr/__init__.py
  • chartarr/cli.py
  • chartarr/demo.py
  • chartarr/lidarr.py
  • chartarr/matcher.py
  • chartarr/review.py
  • chartarr/screen.py
  • tests/test_cli.py
  • tests/test_lidarr.py
  • tests/test_matcher.py
  • tests/test_review.py
  • tests/test_screen.py

Comment thread CHANGELOG.md
- **The review screen pinned a CPU core while it waited for you.** The
progress screens poll for a keypress so they can notice `q` mid-run,
and that non-blocking mode stayed on the window afterwards
and that non-blocking mode stayed on the window afterwards:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use “afterward” for American English.

Change “afterwards” to “afterward” to match the project’s American-English wording convention.

🧰 Tools
🪛 LanguageTool

[locale-violation] ~20-~20: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... non-blocking mode stayed on the window afterwards: curses.wrapper does not reset it b...

(AFTERWARDS_US)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` at line 20, Update the changelog wording from “afterwards” to
“afterward” in the affected sentence, preserving the rest of the text.

Source: Linters/SAST tools

@alperien
alperien merged commit 29d2896 into main Jul 30, 2026
14 checks passed
@alperien
alperien deleted the humanizer-pass branch July 31, 2026 07:26
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