Corrected documentation that disagreed with the code and retargeted deprecations at 'v2.1'.

[AlexSkrypnyk]

Summary

This is a documentation-and-consistency polish pass over the bats-helpers library, with no behavioural changes. It corrects four documentation samples that had drifted from what the code actually prints, normalizes function-description wording across five API reference pages onto the phrasing the README's API reference table already uses, and retargets every deprecation removal notice from the vague "the next version" to the concrete "v2.1" across src/, tests/deprecation.bats, and MIGRATION.md. It also removes four comments from src/steps.bash that only restated the line below them, and corrects the API-table ordering rule stated in CLAUDE.md so it describes the ordering the table actually follows.

Changes

• Documentation samples corrected to match actual output - docs/assertions-line.md's out-of-range sample now quotes the index the way src/assert.line.bash actually does; docs/retry.md's exhausted-retry sample now shows the real format_error block (title, command, limit, attempts, elapsed, last status, last output rows) and explains the limit row; docs/steps.md corrects how <mock_status> can be omitted; docs/tui.md's sample output gains the match mode and case rows the code actually prints.
• Function-description wording normalized - docs/assertions-command.md, docs/assertions-file.md, docs/assertions-git.md, docs/assertions-line.md, and docs/mocking.md reword table rows from "Checks if..." / "Checks the..." to "Asserts that..." / "Asserts the...", matching the phrasing already used in the README's API reference table.
• Deprecation removal target retargeted to v2.1 - every "will be removed in the next version" notice across src/assert.command.bash, src/assert.file.bash, src/assert.git.bash, src/assert.string.bash, src/file.bash, src/fixture.bash, src/mock.bash, src/steps.bash, and src/tui.bash, plus every matching assertion in tests/deprecation.bats, now names v2.1; MIGRATION.md's intro line moves from v2 to v2.1 to match.
• WHAT-comments removed from src/steps.bash - four comments that only restated the statement directly below them are dropped, leaving the code to speak for itself.
• API-table ordering rule corrected in CLAUDE.md - the rule describing the README API reference table's within-module ordering now states that it follows the order each module's documentation page presents its functions, rather than load.bash definition order.

Before / After

┌────────────────────────────────────────────────────────────────────────┐
│ docs/assertions-line.md sample vs. what the code actually prints       │
│                                                                        │
│   BEFORE  "Line index 5 is out of range for output with 2 lines."      │
│   CODE    "Line index '5' is out of range for output with 2 lines."    │
│   AFTER   "Line index '5' is out of range for output with 2 lines."    │
│            ^ sample now matches the code                               │
│                                                                        │
├────────────────────────────────────────────────────────────────────────┤
│                                                                        │
│ MIGRATION.md intro vs. every deprecation notice in src/ and tests/     │
│                                                                        │
│   BEFORE  intro: "...until v2."      notices: "...the next version."   │
│   AFTER   intro: "...until v2.1."    notices: "...v2.1."               │
│            ^ one target, one wording everywhere                        │
│                                                                        │
└────────────────────────────────────────────────────────────────────────┘

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 14 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f7ad0cba-d922-4f81-b798-d670bd134094

📥 Commits

Reviewing files that changed from the base of the PR and between 32bc637 and 2d81f85.

📒 Files selected for processing (20)

• CLAUDE.md
• MIGRATION.md
• docs/assertions-command.md
• docs/assertions-file.md
• docs/assertions-git.md
• docs/assertions-line.md
• docs/mocking.md
• docs/retry.md
• docs/steps.md
• docs/tui.md
• src/assert.command.bash
• src/assert.file.bash
• src/assert.git.bash
• src/assert.string.bash
• src/file.bash
• src/fixture.bash
• src/mock.bash
• src/steps.bash
• src/tui.bash
• tests/deprecation.bats

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.12%. Comparing base (32bc637) to head (2d81f85).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          16       16           
  Lines        2397     2397           
=======================================
  Hits         2352     2352           
  Misses         45       45           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.