From b173ce9202d25781bd0ced6e3f5c907b918e2b3c Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Mon, 19 Aug 2024 08:34:08 -0700 Subject: [PATCH] [doc] Clarify Step return values Clarifying what we require for a return value in a cleaning step; basically not much. Change-Id: I28c26d5b2d32d7af8d97900eb029741c8dbb166f --- doc/source/contributor/hardware_managers.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/contributor/hardware_managers.rst b/doc/source/contributor/hardware_managers.rst index 77b973837..23b650987 100644 --- a/doc/source/contributor/hardware_managers.rst +++ b/doc/source/contributor/hardware_managers.rst @@ -114,6 +114,13 @@ message, and no further managers will be called. An example step: else: raise errors.IncompatibleHardwareMethodError() + +.. note:: + + If creating a new step, the value returned must be serializable into an + API response and log message. If replacing an existing step, you should + return a response of the same type and style of the upstream step. + If the step has args, you need to add them to argsinfo and provide the function with extra parameters.