From 5d41209201a172511f37cc1167e1b4424119a598 Mon Sep 17 00:00:00 2001 From: Maxim Rebguns Date: Fri, 12 Apr 2024 15:20:36 -0500 Subject: [PATCH] docs: updated changelog and next version of wonderwords --- CHANGELOG.md | 28 +++++++++++++++++++++++++++- docs/install.rst | 2 +- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21b55ad..f707abc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,33 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) since version 2. -## [Unreleased] +## [3.0.0] - Unreleased + +### Breaking Changes + +- This version officially supports Python 3.8+ +- The command-line interface has changed. Shell scripts relying on + Wonderwords need to be updated + +### Added + +- Speed improvements when using `starts_with` and `ends_with` +- More efficient batch operations and regular expression compilation +- Idiomatic CLI commands +- Profanity filtering +- Support for custom ``Random`` objects and determinism when running + with a specific seed. + +### Fixed + +- Fixes and updates to word lists +- Fixed bug where ``return_less_if_necessary`` would produce result + in incorrect filtering + +### Removed + +- Dropped support for Python 3.6 and 3.7 +- No more dependency on ``importlib_resources`` ## [2.2.0] - 2021-02-17 diff --git a/docs/install.rst b/docs/install.rst index 9b17e0c..c3d6a0b 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -50,7 +50,7 @@ You should get an output similar to the following: .. raw:: html -
Wonderwords v2.3.0
+
Wonderwords v3.0.0
Upgrade -------