Improve docs on how to load/save FrozenNodeIterator

This commit is contained in:
Alexander Graf
2021-04-12 16:53:59 +02:00
parent 2bf175a111
commit e67b9e6c37
3 changed files with 14 additions and 6 deletions

View File

@@ -25,6 +25,13 @@ Iterator :class:`NodeIterator` and a context manager
.. autoclass:: FrozenNodeIterator
:no-show-inheritance:
A serializable representation of a :class:`NodeIterator` instance, saving
its iteration state.
It can be serialized and deserialized with :func:`save_structure_to_file`
and :func:`load_structure_from_file`, as well as with :mod:`json` and
:mod:`pickle` thanks to being a :func:`~collections.namedtuple`.
``resumable_iteration``
"""""""""""""""""""""""