Skip to content

Commit 0e54e4b

Browse files
committed
Flesh out 1.10.0 release
Fixes cattr vs. cattrs need documentation #471
1 parent 3b6bdb7 commit 0e54e4b

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

HISTORY.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# History
2+
```{currentmodule} cattrs
3+
```
24

35
## 24.1.0 (UNRELEASED)
46

@@ -185,11 +187,20 @@
185187

186188
## 1.10.0 (2022-01-04)
187189

188-
- Add PEP 563 (string annotations) support for dataclasses.
190+
```{note}
191+
In this release, _cattrs_ introduces the {mod}`cattrs` package as the main entry point into the library, replacing the `cattr` package.
192+
193+
The `cattr` package is never going away, nor is it technically deprecated.
194+
New functionality will be added only to the `cattrs` package, but there is no need to replace your current imports.
195+
196+
This change mirrors [a similar change in _attrs_](https://www.attrs.org/en/stable/names.html).
197+
```
198+
199+
- Add [PEP 563 (string annotations)](https://peps.python.org/pep-0563/) support for dataclasses.
189200
([#195](https://github.com/python-attrs/cattrs/issues/195))
190201
- Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.
191-
- Rename the `cattr.gen.make_dict_unstructure_fn.omit_if_default` parameter to `_cattrs_omit_if_default`, for consistency. The `omit_if_default` parameters to `GenConverter` and `override` are unchanged.
192-
- Following the changes in _attrs_ 21.3.0, add a `cattrs` package mirroring the existing `cattr` package. Both package names may be used as desired, and the `cattr` package isn't going away.
202+
- Rename the {func}`cattrs.gen.make_dict_unstructure_fn` `omit_if_default` parameter to `_cattrs_omit_if_default`, for consistency. The `omit_if_default` parameters to {class}`GenConverter` and {func}`override` are unchanged.
203+
- Following the changes in _attrs_ 21.3.0, add a {mod}`cattrs` package mirroring the existing `cattr` package. Both package names may be used as desired, and the `cattr` package isn't going away.
193204

194205
## 1.9.0 (2021-12-06)
195206

0 commit comments

Comments
 (0)