Skip to content

docs: drop AI-slop tells from README and mkem doc comment#24

Merged
rubenhensen merged 1 commit into
mainfrom
docs/ai-slop-sweep
May 6, 2026
Merged

docs: drop AI-slop tells from README and mkem doc comment#24
rubenhensen merged 1 commit into
mainfrom
docs/ai-slop-sweep

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented May 6, 2026

Refs #23.

Findings from the AI-slop sweep

The repo is mostly clean. Two hits worth fixing:

  1. README.md:7 — "In the PostGuard ecosystem, this crate provides…"
    ecosystem is on the writing-ai-slop-tells overstretched-metaphor list.
    Rewritten to use "Within PostGuard, this crate supplies…".

  2. src/kem/mkem.rs:2 — "It leverages the underlying IBKEM and a DEM to construct a hybrid encryption scheme"
    leverages is the canonical AI-slop verb (Add Boyen & Waters #3 on the list).
    Rewritten to "It combines the underlying IBKEM with a DEM to form a hybrid encryption scheme".

No other prose tells found:

  • No banned phrases (In today's…, ever-evolving, Embark on a journey, etc.)
  • No em-dash overuse, no rule-of-three lists, no "Conclusion" sections
  • All other doc comments are short, technical, and concrete
  • CHANGELOG.md and Cargo.toml are clean

No UI in this crate, so the design-tells checklist does not apply.

Verification

  • cargo build --release — clean
  • cargo test --release --all-features — 17/17 tests pass

Reviewer quickstart

git fetch origin && git checkout docs/ai-slop-sweep && cargo test --release --all-features

Refs #23.

- README: replace "In the PostGuard ecosystem, this crate provides…" with
  plain phrasing. "ecosystem" is on the AI-slop overstretched-metaphor list.
- src/kem/mkem.rs: replace "leverages" (canonical AI-slop verb) with
  "combines … with".

Mechanical wording fixes only; no code changes.
@dobby-coder dobby-coder Bot requested a review from rubenhensen May 6, 2026 09:50
@dobby-coder dobby-coder Bot marked this pull request as ready for review May 6, 2026 09:53
@rubenhensen rubenhensen merged commit 8a0f335 into main May 6, 2026
7 checks passed
@rubenhensen rubenhensen deleted the docs/ai-slop-sweep branch May 6, 2026 09:54
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