Skip to content

fixed the docs, CHANGELOG, migration table, and a new section on keeping the legacy word list - #53

Merged
master-wayne7 merged 1 commit into
developfrom
feat/clarify-lazy-init-docs
Sep 5, 2026
Merged

fixed the docs, CHANGELOG, migration table, and a new section on keeping the legacy word list#53
master-wayne7 merged 1 commit into
developfrom
feat/clarify-lazy-init-docs

Conversation

@master-wayne7

@master-wayne7 master-wayne7 commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Description

What does this PR do?
Updates the docs, CHANGELOG, migration table, and a new section on keeping the legacy word list

Related Issue

Closes #52

Summary by CodeRabbit

  • Documentation
    • Documented the updated lazy initialization behavior in version 3.0.0.
    • Clarified that uninitialized filters now use the larger English word list on first use.
    • Added migration guidance for retaining the legacy word list.
    • Updated examples, migration details, and limitations to reflect this behavior change.

@master-wayne7 master-wayne7 self-assigned this Sep 5, 2026
@master-wayne7
master-wayne7 merged commit c15ef1d into develop Sep 5, 2026
2 of 3 checks passed
@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 1d79bb98-035f-4285-9d97-18fd20009dc3

📥 Commits

Reviewing files that changed from the base of the PR and between 0c4d029 and 6f62660.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • README.md

📝 Walkthrough

Walkthrough

The documentation now states that uninitialized filters lazily load the full Language.english list in 3.0.0. It documents the difference from the 2.x legacy list and shows how callers can retain the legacy behavior.

Changes

Lazy auto-initialization documentation

Layer / File(s) Summary
Document lazy English initialization
README.md, CHANGELOG.md
The documentation identifies Language.english as the lazy word list and records the 3.0.0 behavior change.
Document legacy-list migration
README.md
The README explains the 2.x fallback difference, shows how to use badWords, and updates migration and limitations guidance.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: ricardodalarme

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/clarify-lazy-init-docs

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.

@master-wayne7
master-wayne7 deleted the feat/clarify-lazy-init-docs branch September 5, 2026 08:35
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: clarify that lazy auto-init uses Language.english (~13k), not the legacy badWords fallback (~1.7k)

1 participant