Skip to content

Commit c5c1ac9

Browse files
committed
Tweak docs and history
1 parent 536bb4b commit c5c1ac9

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Diff for: HISTORY.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ History
2020
(`#226 <https://github.com/python-attrs/cattrs/issues/226>`_)
2121
* For ``forbid_extra_keys`` raise custom ``ForbiddenExtraKeyError`` instead of generic ``Exception``.
2222
(`#255 <https://github.com/python-attrs/cattrs/pull/225>`_)
23-
* All preconf converters now support ``loads`` and ``dumps`` directly.
23+
* All preconf converters now support ``loads`` and ``dumps`` directly. See an example `here <https://cattrs.readthedocs.io/en/latest/preconf.html>`_.
2424

2525
1.10.0 (2022-01-04)
2626
-------------------

Diff for: docs/preconf.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
Preconfigured converters
33
========================
44

5-
The :py:mod:`cattr.preconf` package contains factories for preconfigured converters, specifically adjusted for particular serialization libraries.
5+
The :py:mod:`cattrs.preconf` package contains factories for preconfigured converters, specifically adjusted for particular serialization libraries.
66

77
For example, to get a converter configured for BSON:
88

99
.. doctest::
1010

11-
>>> from cattr.preconf.bson import make_converter
11+
>>> from cattrs.preconf.bson import make_converter
1212
>>> converter = make_converter() # Takes the same parameters as the ``GenConverter``
1313

1414
Converters obtained this way can be customized further, just like any other converter.
@@ -27,7 +27,7 @@ These converters support the following classes and type annotations, both for st
2727

2828
.. doctest::
2929

30-
>>> from cattr.preconf.json import make_converter
30+
>>> from cattrs.preconf.json import make_converter
3131
>>> converter = make_converter()
3232

3333
>>> @define

0 commit comments

Comments
 (0)