From 245c1272f2219991194cfead55d03277e68cccd7 Mon Sep 17 00:00:00 2001 From: Andras Kovi Date: Fri, 4 Sep 2020 07:35:10 +0200 Subject: [PATCH] Add more specific description to param_spec Change-Id: I312f1f4b26de31b7a0b6040e371e2e02760728d9 --- mistral_lib/actions/base.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/mistral_lib/actions/base.py b/mistral_lib/actions/base.py index e9e76f1..63c68f2 100644 --- a/mistral_lib/actions/base.py +++ b/mistral_lib/actions/base.py @@ -169,8 +169,10 @@ class ActionDescriptor(abc.ABC): Each parameter name can be either just a name or a string "param=val" where "param" is the name of the parameter - and "val" its default value. All names and values in the - string must be JSON-compatible. + and "val" its default value. The values are only indications + for the user and not used in the action instantiation process. + The string is split along the commas and then the parts along the + equal signs. Escaping is not possible. """ pass