Skip to content

docs(readme): strip benchmark section and detector-count claims - #16

Merged
tn-pisama merged 1 commit into
mainfrom
docs/strip-benchmark-numbers
Jul 30, 2026
Merged

docs(readme): strip benchmark section and detector-count claims#16
tn-pisama merged 1 commit into
mainfrom
docs/strip-benchmark-numbers

Conversation

@tn-pisama

Copy link
Copy Markdown
Contributor

Summary

  • Remove the dedicated "Benchmark Results" section (TRAIL archived-run and Who&When tables) from README.md.
  • Remove the inline "32 core heuristic detectors" / "32 core detectors" count claims; leave the detector table itself untouched.
  • Bump package version to 0.6.1 (pyproject.toml + the source-checkout fallback in src/pisama/__init__.py) since this is a real content change to the published README.

CHANGELOG.md is intentionally untouched -- its precision-boundary disclosure entry is historical record, not a live claim.

This package ships more than 20 detectors (32), so per the removal policy the "20 production-grade" claim is not being forced in here -- the count is just removed with nothing put in its place.

Test plan

  • ruff check src tests passes locally
  • CI (quality, test matrix, distribution) green on this PR
  • After merge: publish a GitHub Release v0.6.1 (this repo's publish.yml triggers on release: published, not on a bare tag push) and confirm pisama==0.6.1 lands on PyPI

…nt claims

The archived TRAIL/Who&When numbers and the "32 core detectors" counts
in the README were stale marketing claims not worth re-litigating in
package docs. Removes the dedicated Benchmark Results section and the
inline detector-count references; leaves CHANGELOG.md's historical
precision-boundary disclosure untouched. Bumps to 0.6.1 (docs-only).
@tn-pisama
tn-pisama merged commit a8cb5e5 into main Jul 30, 2026
9 checks passed
@tn-pisama
tn-pisama deleted the docs/strip-benchmark-numbers branch July 30, 2026 16: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