From ce6fb561cbfabc9dd4cfbe6b1f819ce284a9a1d0 Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Sun, 5 Jul 2020 22:20:26 +0100 Subject: [PATCH] Documentation: Add an important note about layer.metadata --- doc/source/complex-plugin.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/complex-plugin.rst b/doc/source/complex-plugin.rst index 84810c830..0883cc93e 100644 --- a/doc/source/complex-plugin.rst +++ b/doc/source/complex-plugin.rst @@ -242,6 +242,12 @@ may be able to provide. At the moment, the main information that layers may pop Any value can be specified and used by layers but consideration towards ambiguity should be used to ensure that overly generic names aren't used for something and then best describe something else that may be needed later on. +.. note:: + + The data stored in metadata is *not* restored when constructed from a configuration, so metadata should only be + used as a temporary means of storing information to be used in constructing later objects and all information + required to recreate an object must be written through the requirements mechanism. + Writing new Templates and Objects ---------------------------------