Skip to content

Commit ae62e92

Browse files
committed
Update CHANGELOG for 2.1.1
Add 2.1.1 release notes documenting behavior and examples for several API changes
1 parent feef751 commit ae62e92

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,30 @@
22

33
All notable changes to this project are documented in this file.
44

5+
## [2.1.1] - 2026-04-22
6+
7+
### Documentation
8+
9+
- **`similarity`**: documented the formula (normalized Levenshtein:
10+
`1.0 - distance(a, b) / max(len(a), len(b))`). Added edge-case examples
11+
(`""` / `""` → 1.0, fully different → 0.0).
12+
- **`ascii_fold_no_decompose`**: explained when to use it vs `ascii_fold`
13+
skips NFD decomposition, applies only the precomposed replacement table.
14+
Added concrete examples.
15+
- **`strip`**: clarified that `chars` is a **set of graphemes**, not a
16+
literal substring (analogous to Python's `str.strip`).
17+
- **`slugify_opts`**: documented that `max_len: -1` means no limit;
18+
`max_len: 0` produces an empty string. Added examples for all options.
19+
- **`chars`**: promoted the experimental warning to be more prominent —
20+
function may produce incorrect results on complex Unicode sequences.
21+
Directs users to `chars_stdlib` for correctness.
22+
- **`pascal_to_snake`**: noted explicitly that it is an alias for
23+
`camel_to_snake` with identical behaviour.
24+
- **README**: fixed `fill` example — was showing string `"both"` instead
25+
of the `Both` type constructor.
26+
27+
---
28+
529
## [2.1.0] - 2026-03-31
630

731
### Added

0 commit comments

Comments
 (0)