(docs) expand more on the "default" field for parameters #2927
Conversation
Signed-off-by: schristoff <28318173+schristoff@users.noreply.github.com>
schristoff
requested review from
sgettys,
bdegeeter and
troy0820
as code owners
docs/content/wiring.md
Outdated
| @@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters] | |||
| default: "wordpress" | |||
| ``` | |||
|
|
|||
| If using the default parameter field it must be set. However, it must be passed in as an empty | |||
There was a problem hiding this comment.
it's not clear to me what these two sentences mean, maybe could be clearer?
There was a problem hiding this comment.
Sure! Is there an exact part that is confusing to you?
There was a problem hiding this comment.
What does "it must be set" mean, and why you gotta set them to some empty value
There was a problem hiding this comment.
how about the following:
If you decide to use the default parameter field, you must set it as the empty value
does this capture everything you want to say?
There was a problem hiding this comment.
I still dont understand why it has to be empty. Isn't this in contradiction with the above example?
Lines 46 to 52 in 1adfb99
docs/content/wiring.md
Outdated
| @@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters] | |||
| default: "wordpress" | |||
| ``` | |||
|
|
|||
| If using the default parameter field it must be set. However, it must be passed in as an empty | |||
There was a problem hiding this comment.
how about the following:
If you decide to use the default parameter field, you must set it as the empty value
does this capture everything you want to say?
Signed-off-by: schristoff <28318173+schristoff@users.noreply.github.com>
No description provided.