Skip to content
Snippets Groups Projects
Commit 3cf9b5b3 authored by Sebastian Müller's avatar Sebastian Müller 🐈
Browse files

docs: add note to encourage implementation of _validate and _finalize

parent d4b109ce
No related branches found
No related tags found
1 merge request!156Component: don't require to overwrite _validate or _finalize
Pipeline #126290 passed with stages
in 3 minutes
......@@ -189,6 +189,10 @@ This is done in :meth:`.TimeComponent._connect`.
After this connection phase, models can validate their state in :meth:`.TimeComponent._validate`. We do nothing there.
.. note::
It is not strictly required to implement `_validate` but it is highly encouraged to do so.
.. code-block:: Python
# imports...
......@@ -315,6 +319,10 @@ In method :meth:`.TimeComponent._finalize`, the component can do any cleanup req
We do nothing special here.
.. note::
It is not strictly required to implement `_finalize` but it is highly encouraged to do so.
.. code-block:: Python
# imports...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment