Skip to content

Commit

Permalink
docs: updated changelog and next version of wonderwords
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmaxguns committed Apr 12, 2024
1 parent d762dc5 commit 5d41209
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
28 changes: 27 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You should get an output similar to the following:

.. raw:: html

<pre>Wonderwords v2.3.0</pre>
<pre>Wonderwords v3.0.0</pre>

Upgrade
-------
Expand Down

0 comments on commit 5d41209

Please sign in to comment.