Skip to content

docs: align test and coverage claims - #177

Merged
kevincostner17 merged 1 commit into
FreshCode-Org:mainfrom
WilliamK112:agent/docs-coverage-claims
Aug 12, 2026
Merged

docs: align test and coverage claims#177
kevincostner17 merged 1 commit into
FreshCode-Org:mainfrom
WilliamK112:agent/docs-coverage-claims

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the remaining stale 800+ tests / 95%+ coverage claims in the FAQ and feature overview
  • align both pages with the existing 1,200+ tests / 93% CI-enforced coverage gate wording used by the documentation index and repository configuration

Why

The two stale pages contradicted both the documentation index and the actual --cov-fail-under=93 test configuration, which made the project's public quality claims inconsistent.

Validation

  • repository-wide Markdown audit confirms there are no remaining 800+ tests or 95%+ coverage claims
  • consistency assertion confirms the 1,200+ tests and 93% coverage gate wording is present across the public docs
  • mkdocs build --strict
  • git diff --check

Closes #159

AI-assisted: Codex was used to help audit and update the documentation; the final diff and strict documentation build were reviewed locally.

Summary by CodeRabbit

  • Documentation
    • Updated production-readiness FAQ statistics to reflect 1,200+ tests and a 93% CI-enforced coverage gate.
    • Updated the feature overview to mention 1,200+ tests, 93% coverage, and mypy-clean status.
    • Clarified that Python version support and public-dataset validation remain unchanged.

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9464fddc-3498-46ee-b655-38f6ba247c8a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 50ba895b-454b-4570-b2ca-c358d0b340fe

📥 Commits

Reviewing files that changed from the base of the PR and between f4cf5d8 and ab59f1d.

📒 Files selected for processing (2)
  • docs/faq.md
  • docs/feature-overview.md

📝 Walkthrough

Walkthrough

The documentation now states that freshdata has 1,200+ tests and a 93% CI-enforced coverage gate. Other documented support and validation details remain unchanged.

Changes

Documentation metrics

Layer / File(s) Summary
Align documented quality metrics
docs/faq.md, docs/feature-overview.md
Updated test-count and coverage claims to 1,200+ tests and a 93% CI-enforced coverage gate.

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

Possibly related PRs

Suggested reviewers: johnnywilson-portfolio, johnnywilson16

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The updates address issue #159 by replacing stale claims and documenting validation for consistent 93% coverage and 1,200+ tests claims.
Out of Scope Changes check ✅ Passed The changes are limited to the FAQ and feature overview, both of which are within issue #159 scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the documentation change to align test and coverage claims.
Description check ✅ Passed The description explains the changes, rationale, issue, and validation steps, but it omits the template's Type of Change and Checklist sections.
✨ 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.

@WilliamK112
WilliamK112 marked this pull request as ready for review August 12, 2026 11:19
@WilliamK112

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@strix-security

Copy link
Copy Markdown
Contributor

Strix is installed on this repository, but we couldn't run this PR security review because this workspace's trial has ended. Add a card to resume code reviews here.

So far, Strix has reviewed 36 pull requests, surfaced 3 security issues (1 critical/high) and blocked 1 risky merge across this workspace.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor
⚠️ Action not completed

Already reviewed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@kevincostner17 kevincostner17 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verdict: Valid — approve

Checked against #159.

Acceptance criteria

Criterion Status
Single coverage figure (93%) across docs/README Pass after this PR
No contradictory test-count claims Pass — remaining 800+ / 95%+ were only in docs/faq.md and docs/feature-overview.md
Aligns with --cov-fail-under=93 Pass
mkdocs build --strict Pass (author + CI)

Verification

I grepped docs/ and README.md on main:

  • Already correct: docs/index.md (“1,200+ tests, 93% coverage gate”), README.md (93% gate), contributing docs, trust-claims.md
  • Stale (this PR): docs/faq.md, docs/feature-overview.md

After the change, wording matches the enforced gate and the index. No leftover 800+ / 95%+ claims.

Good to merge.

@kevincostner17

Copy link
Copy Markdown
Contributor

Thanks @WilliamK112 — this was a small but important honesty fix.

Aligning FAQ and the feature overview with the actual 93% CI gate (and dropping the stale 800+/95% figures) keeps the public claims consistent. Appreciate you catching and cleaning that up.

@kevincostner17
kevincostner17 merged commit f5b360f into FreshCode-Org:main Aug 12, 2026
15 checks passed
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.

docs: reconcile inconsistent test-count and coverage claims (93% gate)

2 participants