Skip to content

kyal102/claimlint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClaimLint

ClaimLint

CI python license deps

Catch unsupported AI/science/benchmark claims before they hit your README.

python -m claimlint README.md --suggest
README.md:2:11: [unsupported] 'proves new physics' — claims to prove new science/math
    sugg: say 'proposes' or 'suggests' and state what verification is required
README.md:3:25: [overclaim] '100% accurate' — absolute-correctness claim
    sugg: give measured numbers and state limitations
README.md:4:6: [needs_data] 'saves 90% compute' — quantitative claim without data
    sugg: label 'early internal prototype result; requires independent validation' + link the benchmark

It flags three categories — unsupported (proves new physics / proven / solves open problems), overclaim (world's-first, guaranteed, 100% accurate, production-validated, replaces peer review), needs_data (X% savings / Nx faster without data) — and suggests safer wording. Disclaimers ("does not prove…") are not flagged. Code fences are skipped.

Use it as a GitHub Action (the good part)

# .github/workflows/claimlint.yml
name: ClaimLint
on: [pull_request]
jobs:
  claimlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: kyal102/claimlint@v0.1.0
        with:
          files: "README.md docs/**/*.md"
          fail_on: "unsupported,overclaim"

The findings render as a job summary on every PR (screenshot-worthy), and the build fails on the categories you choose.

CLI

python -m claimlint --demo
python -m claimlint README.md --suggest
python -m claimlint README.md --comment      # markdown table (PR-comment style)
python -m claimlint README.md docs/*.md --json
python -m claimlint README.md --fail-on unsupported,overclaim

What it is — and isn't

ClaimLint flags wording, not truth. It is a heuristic linter, not a verifier; it does not judge whether a claim is actually true.

See docs/EXAMPLES.md · docs/LIMITATIONS.md. No dependencies (pure stdlib).

Ecosystem

Part of the public ClaimGate verification-tool ecosystem: ClaimGate · ClaimLint · UnitGate · EvidencePack · ReplayGate · ClaimStack Demo. Public lite tools; the full private engine remains private.

About

Lint READMEs and docs for unsupported AI/science/benchmark claims. CLI + GitHub Action.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages