diff --git a/src/doc/converters.rst b/src/doc/converters.rst index df4a258f1a3b6b3770d7673d17681b6ffb4ddaf6..723fdb6687741c8cb30afa1333ce5c10ce1e8bd0 100644 --- a/src/doc/converters.rst +++ b/src/doc/converters.rst @@ -343,11 +343,13 @@ For further customization, the used as a basis for :ref:`custom converters<Custom Converters>` which can make use of its ``referenced_record_callback`` argument. The ``referenced_record_callback`` can be a callable object which takes -exactly one Record, the one specified via ``record_from_dict``, as an -argument and needs to return that Record after doing whatever custom -treatment is needed. ``referenced_record_callback`` is applied -**after** the properties from the dictionary have been applied as -explained above. +exactly one Record as an argument and needs to return that Record +after doing whatever custom treatment is needed. It is applied to all +Records that are created from the dictionary and it can be used to, +e.g., transform values of some properties, or add special treatment to +all Records of a specific type. ``referenced_record_callback`` is +applied **after** the properties from the dictionary have been applied +as explained above. Further converters ++++++++++++++++++ diff --git a/unittests/test_converters.py b/unittests/test_converters.py index fefb4da9e6964bcbabcb3bb76c973fd3e397c791..5b0654f1d2f9278bd855c6caf783b96b0d72e85c 100644 --- a/unittests/test_converters.py +++ b/unittests/test_converters.py @@ -694,7 +694,7 @@ def test_properties_from_dict_basic(converter_registry): } }, name="Test", converter_registry=converter_registry) - # Tests for Dict with skalars, dict with lists, dict with reference, + # Tests for Dict with scalars, dict with lists, dict with reference, # dict with list of references, dict with reference with reference, named # reference values = GeneralStore()